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. */
29 #include "dispextern.h"
34 #include "intervals.h"
36 #define min(a, b) ((a) < (b) ? (a) : (b))
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 /* Non-nil means it is the window for C-M-v to scroll
127 when the minibuffer is selected. */
129 extern Lisp_Object Vminibuf_scroll_window
;
131 extern Lisp_Object Voverriding_local_map
;
133 Lisp_Object Quser_variable_p
;
135 Lisp_Object Qminibuffer_default
;
137 Lisp_Object Qcurrent_input_method
, Qactivate_input_method
;
139 extern Lisp_Object Qmouse_face
;
141 extern Lisp_Object Qfield
;
143 /* Put minibuf on currently selected frame's minibuffer.
144 We do this whenever the user starts a new minibuffer
145 or when a minibuffer exits. */
148 choose_minibuf_frame ()
150 if (FRAMEP (selected_frame
)
151 && FRAME_LIVE_P (XFRAME (selected_frame
))
152 && !EQ (minibuf_window
, XFRAME (selected_frame
)->minibuffer_window
))
154 struct frame
*sf
= XFRAME (selected_frame
);
157 /* I don't think that any frames may validly have a null minibuffer
159 if (NILP (sf
->minibuffer_window
))
162 /* Under X, we come here with minibuf_window being the
163 minibuffer window of the unused termcap window created in
164 init_window_once. That window doesn't have a buffer. */
165 buffer
= XWINDOW (minibuf_window
)->buffer
;
166 if (BUFFERP (buffer
))
167 Fset_window_buffer (sf
->minibuffer_window
, buffer
);
168 minibuf_window
= sf
->minibuffer_window
;
171 /* Make sure no other frame has a minibuffer as its selected window,
172 because the text would not be displayed in it, and that would be
173 confusing. Only allow the selected frame to do this,
174 and that only if the minibuffer is active. */
176 Lisp_Object tail
, frame
;
178 FOR_EACH_FRAME (tail
, frame
)
179 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame
))))
180 && !(EQ (frame
, selected_frame
)
181 && minibuf_level
> 0))
182 Fset_frame_selected_window (frame
, Fframe_first_window (frame
));
187 choose_minibuf_frame_1 (ignore
)
190 choose_minibuf_frame ();
194 DEFUN ("set-minibuffer-window", Fset_minibuffer_window
,
195 Sset_minibuffer_window
, 1, 1, 0,
196 "Specify which minibuffer window to use for the minibuffer.\n\
197 This effects where the minibuffer is displayed if you put text in it\n\
198 without invoking the usual minibuffer commands.")
202 CHECK_WINDOW (window
, 1);
203 if (! MINI_WINDOW_P (XWINDOW (window
)))
204 error ("Window is not a minibuffer window");
206 minibuf_window
= window
;
212 /* Actual minibuffer invocation. */
214 static Lisp_Object read_minibuf_unwind
P_ ((Lisp_Object
));
215 static Lisp_Object read_minibuf
P_ ((Lisp_Object
, Lisp_Object
,
216 Lisp_Object
, Lisp_Object
,
218 Lisp_Object
, Lisp_Object
,
220 static Lisp_Object read_minibuf_noninteractive
P_ ((Lisp_Object
, Lisp_Object
,
221 Lisp_Object
, Lisp_Object
,
223 Lisp_Object
, Lisp_Object
,
225 static Lisp_Object string_to_object
P_ ((Lisp_Object
, Lisp_Object
));
228 /* Read a Lisp object from VAL and return it. If VAL is an empty
229 string, and DEFALT is a string, read from DEFALT instead of VAL. */
232 string_to_object (val
, defalt
)
233 Lisp_Object val
, defalt
;
235 struct gcpro gcpro1
, gcpro2
;
236 Lisp_Object expr_and_pos
;
239 GCPRO2 (val
, defalt
);
241 if (STRINGP (val
) && XSTRING (val
)->size
== 0
245 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
246 pos
= XINT (Fcdr (expr_and_pos
));
247 if (pos
!= XSTRING (val
)->size
)
249 /* Ignore trailing whitespace; any other trailing junk
252 pos
= string_char_to_byte (val
, pos
);
253 for (i
= pos
; i
< STRING_BYTES (XSTRING (val
)); i
++)
255 int c
= XSTRING (val
)->data
[i
];
256 if (c
!= ' ' && c
!= '\t' && c
!= '\n')
257 error ("Trailing garbage following expression");
261 val
= Fcar (expr_and_pos
);
262 RETURN_UNGCPRO (val
);
266 /* Like read_minibuf but reading from stdin. This function is called
267 from read_minibuf to do the job if noninteractive. */
270 read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
, expflag
,
271 histvar
, histpos
, defalt
, allow_props
,
272 inherit_input_method
)
276 Lisp_Object backup_n
;
282 int inherit_input_method
;
288 fprintf (stdout
, "%s", XSTRING (prompt
)->data
);
294 line
= (char *) xmalloc (size
* sizeof *line
);
295 while ((s
= fgets (line
+ len
, size
- len
, stdin
)) != NULL
296 && (len
= strlen (line
),
297 len
== size
- 1 && line
[len
- 1] != '\n'))
300 line
= (char *) xrealloc (line
, size
);
307 if (len
> 0 && line
[len
- 1] == '\n')
310 val
= build_string (line
);
316 error ("Error reading from stdin");
319 /* If Lisp form desired instead of string, parse it. */
321 val
= string_to_object (val
, defalt
);
327 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
328 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
329 prompting with PROMPT (a string), using history list HISTVAR
330 with initial position HISTPOS. (BACKUP_N should be <= 0.)
332 Normally return the result as a string (the text that was read),
333 but if EXPFLAG is nonzero, read it and return the object read.
334 If HISTVAR is given, save the value read on that history only if it doesn't
335 match the front of that history list exactly. The value is pushed onto
336 the list as the string that was read.
338 DEFALT specifies te default value for the sake of history commands.
340 If ALLOW_PROPS is nonzero, we do not throw away text properties.
342 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
343 current input method. */
346 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
347 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
351 Lisp_Object backup_n
;
357 int inherit_input_method
;
360 int count
= specpdl_ptr
- specpdl
;
361 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
362 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
363 Lisp_Object enable_multibyte
;
364 extern Lisp_Object Qread_only
, Qfront_sticky
;
365 extern Lisp_Object Qrear_nonsticky
;
367 specbind (Qminibuffer_default
, defalt
);
369 single_kboard_state ();
370 #ifdef HAVE_X_WINDOWS
371 if (display_hourglass_p
)
376 ambient_dir
= current_buffer
->directory
;
378 enable_multibyte
= Qnil
;
380 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
381 store them away before we can GC. Don't need to protect
382 BACKUP_N because we use the value only if it is an integer. */
383 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
385 if (!STRINGP (prompt
))
386 prompt
= build_string ("");
388 if (!enable_recursive_minibuffers
389 && minibuf_level
> 0)
391 if (EQ (selected_window
, minibuf_window
))
392 error ("Command attempted to use minibuffer while in minibuffer");
394 /* If we're in another window, cancel the minibuffer that's active. */
396 build_string ("Command attempted to use minibuffer while in minibuffer"));
401 val
= read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
,
402 expflag
, histvar
, histpos
, defalt
,
403 allow_props
, inherit_input_method
);
404 return unbind_to (count
, val
);
407 /* Choose the minibuffer window and frame, and take action on them. */
409 choose_minibuf_frame ();
411 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
413 record_unwind_protect (Fset_window_configuration
,
414 Fcurrent_window_configuration (Qnil
));
416 /* If the minibuffer window is on a different frame, save that
417 frame's configuration too. */
418 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
419 if (!EQ (mini_frame
, selected_frame
))
420 record_unwind_protect (Fset_window_configuration
,
421 Fcurrent_window_configuration (mini_frame
));
423 /* If the minibuffer is on an iconified or invisible frame,
424 make it visible now. */
425 Fmake_frame_visible (mini_frame
);
427 if (minibuffer_auto_raise
)
428 Fraise_frame (mini_frame
);
430 /* We have to do this after saving the window configuration
431 since that is what restores the current buffer. */
433 /* Arrange to restore a number of minibuffer-related variables.
434 We could bind each variable separately, but that would use lots of
437 = Fcons (Voverriding_local_map
,
438 Fcons (minibuf_window
, minibuf_save_list
));
440 = Fcons (minibuf_prompt
,
441 Fcons (make_number (minibuf_prompt_width
),
443 Fcons (Vcurrent_prefix_arg
,
444 Fcons (Vminibuffer_history_position
,
445 Fcons (Vminibuffer_history_variable
,
446 minibuf_save_list
))))));
448 record_unwind_protect (read_minibuf_unwind
, Qnil
);
451 /* Now that we can restore all those variables, start changing them. */
453 minibuf_prompt_width
= 0;
454 minibuf_prompt
= Fcopy_sequence (prompt
);
455 Vminibuffer_history_position
= histpos
;
456 Vminibuffer_history_variable
= histvar
;
457 Vhelp_form
= Vminibuffer_help_form
;
459 if (inherit_input_method
)
461 /* `current-input-method' is buffer local. So, remeber it in
462 INPUT_METHOD before changing the current buffer. */
463 input_method
= Fsymbol_value (Qcurrent_input_method
);
464 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
467 /* Switch to the minibuffer. */
469 minibuffer
= get_minibuffer (minibuf_level
);
470 Fset_buffer (minibuffer
);
472 /* The current buffer's default directory is usually the right thing
473 for our minibuffer here. However, if you're typing a command at
474 a minibuffer-only frame when minibuf_level is zero, then buf IS
475 the current_buffer, so reset_buffer leaves buf's default
476 directory unchanged. This is a bummer when you've just started
477 up Emacs and buf's default directory is Qnil. Here's a hack; can
478 you think of something better to do? Find another buffer with a
479 better directory, and use that one instead. */
480 if (STRINGP (ambient_dir
))
481 current_buffer
->directory
= ambient_dir
;
484 Lisp_Object buf_list
;
486 for (buf_list
= Vbuffer_alist
;
488 buf_list
= XCDR (buf_list
))
490 Lisp_Object other_buf
;
492 other_buf
= XCDR (XCAR (buf_list
));
493 if (STRINGP (XBUFFER (other_buf
)->directory
))
495 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
501 if (!EQ (mini_frame
, selected_frame
))
502 Fredirect_frame_focus (selected_frame
, mini_frame
);
504 Vminibuf_scroll_window
= selected_window
;
505 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
506 Fselect_window (minibuf_window
);
507 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
509 Fmake_local_variable (Qprint_escape_newlines
);
510 print_escape_newlines
= 1;
512 /* Erase the buffer. */
514 int count1
= BINDING_STACK_SIZE ();
515 specbind (Qinhibit_read_only
, Qt
);
516 specbind (Qinhibit_modification_hooks
, Qt
);
518 unbind_to (count1
, Qnil
);
521 if (!NILP (current_buffer
->enable_multibyte_characters
)
522 && ! STRING_MULTIBYTE (minibuf_prompt
))
523 minibuf_prompt
= Fstring_make_multibyte (minibuf_prompt
);
525 /* Insert the prompt, record where it ends. */
526 Finsert (1, &minibuf_prompt
);
529 Fput_text_property (make_number (BEG
), make_number (PT
),
530 Qfront_sticky
, Qt
, Qnil
);
531 Fput_text_property (make_number (BEG
), make_number (PT
),
532 Qrear_nonsticky
, Qt
, Qnil
);
533 Fput_text_property (make_number (BEG
), make_number (PT
),
535 Fadd_text_properties (make_number (BEG
), make_number (PT
),
536 Vminibuffer_prompt_properties
, Qnil
);
539 minibuf_prompt_width
= current_column ();
541 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
542 if (inherit_input_method
)
543 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
545 /* Put in the initial input. */
548 Finsert (1, &initial
);
549 if (INTEGERP (backup_n
))
550 Fforward_char (backup_n
);
553 clear_message (1, 1);
554 current_buffer
->keymap
= map
;
556 /* Turn on an input method stored in INPUT_METHOD if any. */
557 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
558 call1 (Qactivate_input_method
, input_method
);
560 /* Run our hook, but not if it is empty.
561 (run-hooks would do nothing if it is empty,
562 but it's important to save time here in the usual case). */
563 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
564 && !NILP (Vrun_hooks
))
565 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
567 /* Don't allow the user to undo past this point. */
568 current_buffer
->undo_list
= Qnil
;
572 /* If cursor is on the minibuffer line,
573 show the user we have exited by putting it in column 0. */
574 if (XWINDOW (minibuf_window
)->cursor
.vpos
>= 0
577 XWINDOW (minibuf_window
)->cursor
.hpos
= 0;
578 XWINDOW (minibuf_window
)->cursor
.x
= 0;
579 XWINDOW (minibuf_window
)->must_be_updated_p
= 1;
580 update_frame (XFRAME (selected_frame
), 1, 1);
581 if (rif
&& rif
->flush_display
)
582 rif
->flush_display (XFRAME (XWINDOW (minibuf_window
)->frame
));
585 /* Make minibuffer contents into a string. */
586 Fset_buffer (minibuffer
);
588 val
= Ffield_string (make_number (ZV
));
590 val
= Ffield_string_no_properties (make_number (ZV
));
592 /* VAL is the string of minibuffer text. */
594 last_minibuf_string
= val
;
596 /* Add the value to the appropriate history list unless it is empty. */
597 if (XSTRING (val
)->size
!= 0
598 && SYMBOLP (Vminibuffer_history_variable
))
600 /* If the caller wanted to save the value read on a history list,
601 then do so if the value is not already the front of the list. */
604 /* If variable is unbound, make it nil. */
605 if (EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
606 Fset (Vminibuffer_history_variable
, Qnil
);
608 histval
= Fsymbol_value (Vminibuffer_history_variable
);
610 /* The value of the history variable must be a cons or nil. Other
611 values are unacceptable. We silently ignore these values. */
614 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
618 histval
= Fcons (last_minibuf_string
, histval
);
619 Fset (Vminibuffer_history_variable
, histval
);
621 /* Truncate if requested. */
622 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
623 if (NILP (length
)) length
= Vhistory_length
;
624 if (INTEGERP (length
))
626 if (XINT (length
) <= 0)
627 Fset (Vminibuffer_history_variable
, Qnil
);
632 temp
= Fnthcdr (Fsub1 (length
), histval
);
633 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
639 /* If Lisp form desired instead of string, parse it. */
641 val
= string_to_object (val
, defalt
);
643 /* The appropriate frame will get selected
644 in set-window-configuration. */
645 RETURN_UNGCPRO (unbind_to (count
, val
));
648 /* Return a buffer to be used as the minibuffer at depth `depth'.
649 depth = 0 is the lowest allowed argument, and that is the value
650 used for nonrecursive minibuffer invocations */
653 get_minibuffer (depth
)
656 Lisp_Object tail
, num
, buf
;
658 extern Lisp_Object
nconc2 ();
660 XSETFASTINT (num
, depth
);
661 tail
= Fnthcdr (num
, Vminibuffer_list
);
664 tail
= Fcons (Qnil
, Qnil
);
665 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
668 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
670 sprintf (name
, " *Minibuf-%d*", depth
);
671 buf
= Fget_buffer_create (build_string (name
));
673 /* Although the buffer's name starts with a space, undo should be
675 Fbuffer_enable_undo (buf
);
681 int count
= specpdl_ptr
- specpdl
;
683 reset_buffer (XBUFFER (buf
));
684 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
686 Fkill_all_local_variables ();
687 unbind_to (count
, Qnil
);
693 /* This function is called on exiting minibuffer, whether normally or
694 not, and it restores the current window, buffer, etc. */
697 read_minibuf_unwind (data
)
700 Lisp_Object old_deactivate_mark
;
703 /* We are exiting the minibuffer one way or the other,
705 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
706 && !NILP (Vrun_hooks
))
707 safe_run_hooks (Qminibuffer_exit_hook
);
709 /* If this was a recursive minibuffer,
710 tie the minibuffer window back to the outer level minibuffer buffer. */
713 window
= minibuf_window
;
714 /* To keep things predictable, in case it matters, let's be in the
715 minibuffer when we reset the relevant variables. */
716 Fset_buffer (XWINDOW (window
)->buffer
);
718 /* Restore prompt, etc, from outer minibuffer level. */
719 minibuf_prompt
= Fcar (minibuf_save_list
);
720 minibuf_save_list
= Fcdr (minibuf_save_list
);
721 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
722 minibuf_save_list
= Fcdr (minibuf_save_list
);
723 Vhelp_form
= Fcar (minibuf_save_list
);
724 minibuf_save_list
= Fcdr (minibuf_save_list
);
725 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
726 minibuf_save_list
= Fcdr (minibuf_save_list
);
727 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
728 minibuf_save_list
= Fcdr (minibuf_save_list
);
729 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
730 minibuf_save_list
= Fcdr (minibuf_save_list
);
731 Voverriding_local_map
= Fcar (minibuf_save_list
);
732 minibuf_save_list
= Fcdr (minibuf_save_list
);
734 temp
= Fcar (minibuf_save_list
);
735 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
736 minibuf_window
= temp
;
738 minibuf_save_list
= Fcdr (minibuf_save_list
);
740 /* Erase the minibuffer we were using at this level. */
742 int count
= specpdl_ptr
- specpdl
;
743 /* Prevent error in erase-buffer. */
744 specbind (Qinhibit_read_only
, Qt
);
745 old_deactivate_mark
= Vdeactivate_mark
;
747 Vdeactivate_mark
= old_deactivate_mark
;
748 unbind_to (count
, Qnil
);
751 /* When we get to the outmost level, make sure we resize the
752 mini-window back to its normal size. */
753 if (minibuf_level
== 0)
754 resize_mini_window (XWINDOW (window
), 0);
756 /* Make sure minibuffer window is erased, not ignored. */
757 windows_or_buffers_changed
++;
758 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
759 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
764 /* This comment supplies the doc string for read-from-minibuffer,
765 for make-docfile to see. We cannot put this in the real DEFUN
766 due to limits in the Unix cpp.
768 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
769 "Read a string from the minibuffer, prompting with string PROMPT.\n\
770 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
771 to be inserted into the minibuffer before reading input.\n\
772 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
773 is STRING, but point is placed at position POSITION in the minibuffer.\n\
774 Third arg KEYMAP is a keymap to use whilst reading;\n\
775 if omitted or nil, the default is `minibuffer-local-map'.\n\
776 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
777 and return that object:\n\
778 in other words, do `(car (read-from-string INPUT-STRING))'\n\
779 Fifth arg HIST, if non-nil, specifies a history list\n\
780 and optionally the initial position in the list.\n\
781 It can be a symbol, which is the history list variable to use,\n\
782 or it can be a cons cell (HISTVAR . HISTPOS).\n\
783 In that case, HISTVAR is the history list variable to use,\n\
784 and HISTPOS is the initial position (the position in the list\n\
785 which INITIAL-CONTENTS corresponds to).\n\
786 Positions are counted starting from 1 at the beginning of the list.\n\
787 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
788 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
789 if the user enters empty input! It returns the empty string.\n\
790 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
791 the current input method and the setting of enable-multibyte-characters.\n\
792 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
793 then the string which is returned includes whatever text properties\n\
794 were present in the minibuffer. Otherwise the value has no text properties.")
795 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
798 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
799 0 /* See immediately above */)
800 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
801 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
802 Lisp_Object inherit_input_method
;
805 Lisp_Object histvar
, histpos
, position
, val
;
810 CHECK_STRING (prompt
, 0);
811 if (!NILP (initial_contents
))
813 if (CONSP (initial_contents
))
815 position
= Fcdr (initial_contents
);
816 initial_contents
= Fcar (initial_contents
);
818 CHECK_STRING (initial_contents
, 1);
819 if (!NILP (position
))
821 CHECK_NUMBER (position
, 0);
822 /* Convert to distance from end of input. */
823 if (XINT (position
) < 1)
824 /* A number too small means the beginning of the string. */
825 pos
= - XSTRING (initial_contents
)->size
;
827 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
832 keymap
= Vminibuffer_local_map
;
834 keymap
= get_keymap (keymap
, 1, 0);
843 histvar
= Fcar_safe (hist
);
844 histpos
= Fcdr_safe (hist
);
847 histvar
= Qminibuffer_history
;
849 XSETFASTINT (histpos
, 0);
851 GCPRO1 (default_value
);
852 val
= read_minibuf (keymap
, initial_contents
, prompt
,
853 make_number (pos
), !NILP (read
),
854 histvar
, histpos
, default_value
,
855 minibuffer_allow_text_properties
,
856 !NILP (inherit_input_method
));
861 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
862 "Return a Lisp object read using the minibuffer.\n\
863 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
864 is a string to insert in the minibuffer before reading.")
865 (prompt
, initial_contents
)
866 Lisp_Object prompt
, initial_contents
;
868 CHECK_STRING (prompt
, 0);
869 if (!NILP (initial_contents
))
870 CHECK_STRING (initial_contents
, 1);
871 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
872 prompt
, Qnil
, 1, Qminibuffer_history
,
873 make_number (0), Qnil
, 0, 0);
876 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
877 "Return value of Lisp expression read using the minibuffer.\n\
878 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
879 is a string to insert in the minibuffer before reading.")
880 (prompt
, initial_contents
)
881 Lisp_Object prompt
, initial_contents
;
883 return Feval (Fread_minibuffer (prompt
, initial_contents
));
886 /* Functions that use the minibuffer to read various things. */
888 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
889 "Read a string from the minibuffer, prompting with string PROMPT.\n\
890 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
891 The third arg HISTORY, if non-nil, specifies a history list\n\
892 and optionally the initial position in the list.\n\
893 See `read-from-minibuffer' for details of HISTORY argument.\n\
894 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
895 for history commands, and as the value to return if the user enters\n\
897 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
898 the current input method and the setting of enable-multibyte-characters.")
899 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
900 Lisp_Object prompt
, initial_input
, history
, default_value
;
901 Lisp_Object inherit_input_method
;
904 val
= Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
905 Qnil
, history
, default_value
,
906 inherit_input_method
);
907 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
912 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
913 "Read a string from the terminal, not allowing blanks.\n\
914 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
915 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
916 the current input method and the setting of enable-multibyte-characters.")
917 (prompt
, initial
, inherit_input_method
)
918 Lisp_Object prompt
, initial
, inherit_input_method
;
920 CHECK_STRING (prompt
, 0);
921 if (! NILP (initial
))
922 CHECK_STRING (initial
, 1);
924 return read_minibuf (Vminibuffer_local_ns_map
, initial
, prompt
, Qnil
,
925 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
926 !NILP (inherit_input_method
));
929 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
930 "Read the name of a command and return as a symbol.\n\
931 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
932 (prompt
, default_value
)
933 Lisp_Object prompt
, default_value
;
935 Lisp_Object name
, default_string
;
937 if (NILP (default_value
))
938 default_string
= Qnil
;
939 else if (SYMBOLP (default_value
))
940 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
942 default_string
= default_value
;
944 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
945 Qnil
, Qnil
, default_string
, Qnil
);
948 return Fintern (name
, Qnil
);
952 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
953 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
954 Prompts with PROMPT.")
958 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
963 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
964 "Read the name of a user variable and return it as a symbol.\n\
965 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
966 A user variable is one whose documentation starts with a `*' character.")
967 (prompt
, default_value
)
968 Lisp_Object prompt
, default_value
;
970 Lisp_Object name
, default_string
;
972 if (NILP (default_value
))
973 default_string
= Qnil
;
974 else if (SYMBOLP (default_value
))
975 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
977 default_string
= default_value
;
979 name
= Fcompleting_read (prompt
, Vobarray
,
980 Quser_variable_p
, Qt
,
981 Qnil
, Qnil
, default_string
, Qnil
);
984 return Fintern (name
, Qnil
);
987 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
988 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
989 Prompts with PROMPT.\n\
990 Optional second arg DEF is value to return if user enters an empty line.\n\
991 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
992 (prompt
, def
, require_match
)
993 Lisp_Object prompt
, def
, require_match
;
998 def
= XBUFFER (def
)->name
;
1000 if (NILP (Vread_buffer_function
))
1004 args
[0] = build_string ("%s(default %s) ");
1007 prompt
= Fformat (3, args
);
1010 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
1011 require_match
, Qnil
, Qbuffer_name_history
,
1016 args
[0] = Vread_buffer_function
;
1019 args
[3] = require_match
;
1020 return Ffuncall(4, args
);
1025 minibuf_conform_representation (string
, basis
)
1026 Lisp_Object string
, basis
;
1028 if (STRING_MULTIBYTE (string
) == STRING_MULTIBYTE (basis
))
1031 if (STRING_MULTIBYTE (string
))
1032 return Fstring_make_unibyte (string
);
1034 return Fstring_make_multibyte (string
);
1037 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
1038 "Return common substring of all completions of STRING in ALIST.\n\
1039 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1040 All that match are compared together; the longest initial sequence\n\
1041 common to all matches is returned as a string.\n\
1042 If there is no match at all, nil is returned.\n\
1043 For a unique match which is exact, t is returned.\n\
1045 ALIST can be an obarray instead of an alist.\n\
1046 Then the print names of all symbols in the obarray are the possible matches.\n\
1048 ALIST can also be a function to do the completion itself.\n\
1049 It receives three arguments: the values STRING, PREDICATE and nil.\n\
1050 Whatever it returns becomes the value of `try-completion'.\n\
1052 If optional third argument PREDICATE is non-nil,\n\
1053 it is used to test each possible match.\n\
1054 The match is a candidate only if PREDICATE returns non-nil.\n\
1055 The argument given to PREDICATE is the alist element\n\
1056 or the symbol from the obarray.\n\
1057 Additionally to this predicate, `completion-regexp-list'\n\
1058 is used to further constrain the set of candidates.")
1059 (string
, alist
, predicate
)
1060 Lisp_Object string
, alist
, predicate
;
1062 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
1063 /* Size in bytes of BESTMATCH. */
1064 int bestmatchsize
= 0;
1065 /* These are in bytes, too. */
1066 int compare
, matchsize
;
1067 int list
= CONSP (alist
) || NILP (alist
);
1068 int index
= 0, obsize
= 0;
1070 Lisp_Object bucket
, zero
, end
, tem
;
1071 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1073 CHECK_STRING (string
, 0);
1074 if (!list
&& !VECTORP (alist
))
1075 return call3 (alist
, string
, predicate
, Qnil
);
1077 bestmatch
= bucket
= Qnil
;
1079 /* If ALIST is not a list, set TAIL just for gc pro. */
1084 obsize
= XVECTOR (alist
)->size
;
1085 bucket
= XVECTOR (alist
)->contents
[index
];
1090 /* Get the next element of the alist or obarray. */
1091 /* Exit the loop if the elements are all used up. */
1092 /* elt gets the alist element or symbol.
1093 eltstring gets the name to check as a completion. */
1100 eltstring
= Fcar (elt
);
1105 if (XFASTINT (bucket
) != 0)
1108 eltstring
= Fsymbol_name (elt
);
1109 if (XSYMBOL (bucket
)->next
)
1110 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1112 XSETFASTINT (bucket
, 0);
1114 else if (++index
>= obsize
)
1118 bucket
= XVECTOR (alist
)->contents
[index
];
1123 /* Is this element a possible completion? */
1125 if (STRINGP (eltstring
)
1126 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1127 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1128 make_number (XSTRING (string
)->size
),
1129 string
, make_number (0), Qnil
,
1130 completion_ignore_case
?Qt
: Qnil
),
1134 Lisp_Object regexps
;
1136 XSETFASTINT (zero
, 0);
1138 /* Ignore this element if it fails to match all the regexps. */
1139 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1140 regexps
= XCDR (regexps
))
1142 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1146 if (CONSP (regexps
))
1149 /* Ignore this element if there is a predicate
1150 and the predicate doesn't like it. */
1152 if (!NILP (predicate
))
1154 if (EQ (predicate
, Qcommandp
))
1155 tem
= Fcommandp (elt
);
1158 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
1159 tem
= call1 (predicate
, elt
);
1162 if (NILP (tem
)) continue;
1165 /* Update computation of how much all possible completions match */
1168 if (NILP (bestmatch
))
1170 bestmatch
= eltstring
;
1171 bestmatchsize
= XSTRING (eltstring
)->size
;
1175 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
1176 tem
= Fcompare_strings (bestmatch
, make_number (0),
1177 make_number (compare
),
1178 eltstring
, make_number (0),
1179 make_number (compare
),
1180 completion_ignore_case
? Qt
: Qnil
);
1182 matchsize
= compare
;
1183 else if (XINT (tem
) < 0)
1184 matchsize
= - XINT (tem
) - 1;
1186 matchsize
= XINT (tem
) - 1;
1189 matchsize
= compare
;
1190 if (completion_ignore_case
)
1192 /* If this is an exact match except for case,
1193 use it as the best match rather than one that is not an
1194 exact match. This way, we get the case pattern
1195 of the actual match. */
1196 if ((matchsize
== XSTRING (eltstring
)->size
1197 && matchsize
< XSTRING (bestmatch
)->size
)
1199 /* If there is more than one exact match ignoring case,
1200 and one of them is exact including case,
1202 /* If there is no exact match ignoring case,
1203 prefer a match that does not change the case
1205 ((matchsize
== XSTRING (eltstring
)->size
)
1207 (matchsize
== XSTRING (bestmatch
)->size
)
1208 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1209 make_number (XSTRING (string
)->size
),
1210 string
, make_number (0),
1214 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1215 make_number (XSTRING (string
)->size
),
1216 string
, make_number (0),
1220 bestmatch
= eltstring
;
1222 bestmatchsize
= matchsize
;
1227 if (NILP (bestmatch
))
1228 return Qnil
; /* No completions found */
1229 /* If we are ignoring case, and there is no exact match,
1230 and no additional text was supplied,
1231 don't change the case of what the user typed. */
1232 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
1233 && XSTRING (bestmatch
)->size
> bestmatchsize
)
1234 return minibuf_conform_representation (string
, bestmatch
);
1236 /* Return t if the supplied string is an exact match (counting case);
1237 it does not require any change to be made. */
1238 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
1239 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1240 make_number (bestmatchsize
),
1241 string
, make_number (0),
1242 make_number (bestmatchsize
),
1247 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1248 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1249 return Fsubstring (bestmatch
, zero
, end
);
1252 /* Compare exactly LEN chars of strings at S1 and S2,
1253 ignoring case if appropriate.
1254 Return -1 if strings match,
1255 else number of chars that match at the beginning. */
1259 register unsigned char *s1
, *s2
;
1262 register int l
= len
;
1264 if (completion_ignore_case
)
1266 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1271 while (l
&& *s1
++ == *s2
++)
1278 int match
= len
- l
;
1280 /* Now *--S1 is the unmatching byte. If it is in the middle of
1281 multi-byte form, we must say that the multi-byte character
1282 there doesn't match. */
1283 while (match
&& *--s1
>= 0xA0) match
--;
1288 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1289 "Search for partial matches to STRING in ALIST.\n\
1290 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1291 The value is a list of all the strings from ALIST that match.\n\
1293 ALIST can be an obarray instead of an alist.\n\
1294 Then the print names of all symbols in the obarray are the possible matches.\n\
1296 ALIST can also be a function to do the completion itself.\n\
1297 It receives three arguments: the values STRING, PREDICATE and t.\n\
1298 Whatever it returns becomes the value of `all-completions'.\n\
1300 If optional third argument PREDICATE is non-nil,\n\
1301 it is used to test each possible match.\n\
1302 The match is a candidate only if PREDICATE returns non-nil.\n\
1303 The argument given to PREDICATE is the alist element\n\
1304 or the symbol from the obarray.\n\
1305 Additionally to this predicate, `completion-regexp-list'\n\
1306 is used to further constrain the set of candidates.\n\
1308 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1309 strings in ALIST that start with a space\n\
1310 are ignored unless STRING itself starts with a space.")
1311 (string
, alist
, predicate
, hide_spaces
)
1312 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1314 Lisp_Object tail
, elt
, eltstring
;
1315 Lisp_Object allmatches
;
1316 int list
= CONSP (alist
) || NILP (alist
);
1317 int index
= 0, obsize
= 0;
1318 Lisp_Object bucket
, tem
;
1319 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1321 CHECK_STRING (string
, 0);
1322 if (!list
&& !VECTORP (alist
))
1324 return call3 (alist
, string
, predicate
, Qt
);
1326 allmatches
= bucket
= Qnil
;
1328 /* If ALIST is not a list, set TAIL just for gc pro. */
1333 obsize
= XVECTOR (alist
)->size
;
1334 bucket
= XVECTOR (alist
)->contents
[index
];
1339 /* Get the next element of the alist or obarray. */
1340 /* Exit the loop if the elements are all used up. */
1341 /* elt gets the alist element or symbol.
1342 eltstring gets the name to check as a completion. */
1349 eltstring
= Fcar (elt
);
1354 if (XFASTINT (bucket
) != 0)
1357 eltstring
= Fsymbol_name (elt
);
1358 if (XSYMBOL (bucket
)->next
)
1359 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1361 XSETFASTINT (bucket
, 0);
1363 else if (++index
>= obsize
)
1367 bucket
= XVECTOR (alist
)->contents
[index
];
1372 /* Is this element a possible completion? */
1374 if (STRINGP (eltstring
)
1375 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1376 /* If HIDE_SPACES, reject alternatives that start with space
1377 unless the input starts with space. */
1378 && ((STRING_BYTES (XSTRING (string
)) > 0
1379 && XSTRING (string
)->data
[0] == ' ')
1380 || XSTRING (eltstring
)->data
[0] != ' '
1381 || NILP (hide_spaces
))
1382 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1383 make_number (XSTRING (string
)->size
),
1384 string
, make_number (0),
1385 make_number (XSTRING (string
)->size
),
1386 completion_ignore_case
? Qt
: Qnil
),
1390 Lisp_Object regexps
;
1392 XSETFASTINT (zero
, 0);
1394 /* Ignore this element if it fails to match all the regexps. */
1395 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1396 regexps
= XCDR (regexps
))
1398 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1402 if (CONSP (regexps
))
1405 /* Ignore this element if there is a predicate
1406 and the predicate doesn't like it. */
1408 if (!NILP (predicate
))
1410 if (EQ (predicate
, Qcommandp
))
1411 tem
= Fcommandp (elt
);
1414 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1415 tem
= call1 (predicate
, elt
);
1418 if (NILP (tem
)) continue;
1420 /* Ok => put it on the list. */
1421 allmatches
= Fcons (eltstring
, allmatches
);
1425 return Fnreverse (allmatches
);
1428 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1429 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1430 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1431 Lisp_Object Vminibuffer_completing_file_name
;
1433 /* This comment supplies the doc string for completing-read,
1434 for make-docfile to see. We cannot put this in the real DEFUN
1435 due to limits in the Unix cpp.
1437 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1438 "Read a string in the minibuffer, with completion.\n\
1439 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1440 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1441 TABLE can also be a function to do the completion itself.\n\
1442 PREDICATE limits completion to a subset of TABLE.\n\
1443 See `try-completion' and `all-completions' for more details\n\
1444 on completion, TABLE, and PREDICATE.\n\
1446 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1447 the input is (or completes to) an element of TABLE or is null.\n\
1448 If it is also not t, Return does not exit if it does non-null completion.\n\
1449 If the input is null, `completing-read' returns an empty string,\n\
1450 regardless of the value of REQUIRE-MATCH.\n\
1452 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1453 If it is (STRING . POSITION), the initial input\n\
1454 is STRING, but point is placed POSITION characters into the string.\n\
1455 This feature is deprecated--it is best to pass nil for INITIAL.\n\
1456 HIST, if non-nil, specifies a history list\n\
1457 and optionally the initial position in the list.\n\
1458 It can be a symbol, which is the history list variable to use,\n\
1459 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1460 In that case, HISTVAR is the history list variable to use,\n\
1461 and HISTPOS is the initial position (the position in the list\n\
1462 which INITIAL-INPUT corresponds to).\n\
1463 Positions are counted starting from 1 at the beginning of the list.\n\
1464 DEF, if non-nil, is the default value.\n\
1466 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1467 the current input method and the setting of enable-multibyte-characters.\n\
1469 Completion ignores case if the ambient value of\n\
1470 `completion-ignore-case' is non-nil."
1472 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1473 0 /* See immediately above */)
1474 (prompt
, table
, predicate
, require_match
, initial_input
, hist
, def
, inherit_input_method
)
1475 Lisp_Object prompt
, table
, predicate
, require_match
, initial_input
;
1476 Lisp_Object hist
, def
, inherit_input_method
;
1478 Lisp_Object val
, histvar
, histpos
, position
;
1481 int count
= specpdl_ptr
- specpdl
;
1482 struct gcpro gcpro1
;
1484 init
= initial_input
;
1487 specbind (Qminibuffer_completion_table
, table
);
1488 specbind (Qminibuffer_completion_predicate
, predicate
);
1489 specbind (Qminibuffer_completion_confirm
,
1490 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1491 last_exact_completion
= Qnil
;
1498 position
= Fcdr (init
);
1501 CHECK_STRING (init
, 0);
1502 if (!NILP (position
))
1504 CHECK_NUMBER (position
, 0);
1505 /* Convert to distance from end of input. */
1506 pos
= XINT (position
) - XSTRING (init
)->size
;
1517 histvar
= Fcar_safe (hist
);
1518 histpos
= Fcdr_safe (hist
);
1521 histvar
= Qminibuffer_history
;
1523 XSETFASTINT (histpos
, 0);
1525 val
= read_minibuf (NILP (require_match
)
1526 ? Vminibuffer_local_completion_map
1527 : Vminibuffer_local_must_match_map
,
1528 init
, prompt
, make_number (pos
), 0,
1529 histvar
, histpos
, def
, 0,
1530 !NILP (inherit_input_method
));
1532 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1535 RETURN_UNGCPRO (unbind_to (count
, val
));
1538 Lisp_Object
Fminibuffer_completion_help ();
1539 Lisp_Object
assoc_for_completion ();
1541 /* Test whether TXT is an exact completion. */
1543 test_completion (txt
)
1548 if (CONSP (Vminibuffer_completion_table
)
1549 || NILP (Vminibuffer_completion_table
))
1550 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1551 else if (VECTORP (Vminibuffer_completion_table
))
1553 /* Bypass intern-soft as that loses for nil */
1554 tem
= oblookup (Vminibuffer_completion_table
,
1555 XSTRING (txt
)->data
,
1556 XSTRING (txt
)->size
,
1557 STRING_BYTES (XSTRING (txt
)));
1560 if (STRING_MULTIBYTE (txt
))
1561 txt
= Fstring_make_unibyte (txt
);
1563 txt
= Fstring_make_multibyte (txt
);
1565 tem
= oblookup (Vminibuffer_completion_table
,
1566 XSTRING (txt
)->data
,
1567 XSTRING (txt
)->size
,
1568 STRING_BYTES (XSTRING (txt
)));
1572 if (!NILP (Vminibuffer_completion_predicate
))
1573 return call1 (Vminibuffer_completion_predicate
, tem
);
1578 return call3 (Vminibuffer_completion_table
, txt
,
1579 Vminibuffer_completion_predicate
, Qlambda
);
1583 * 0 no possible completion
1584 * 1 was already an exact and unique completion
1585 * 3 was already an exact completion
1586 * 4 completed to an exact completion
1587 * 5 some completion happened
1588 * 6 no completion happened
1593 Lisp_Object completion
, string
, tem
;
1596 struct gcpro gcpro1
, gcpro2
;
1598 completion
= Ftry_completion (Ffield_string (make_number (ZV
)),
1599 Vminibuffer_completion_table
,
1600 Vminibuffer_completion_predicate
);
1601 last
= last_exact_completion
;
1602 last_exact_completion
= Qnil
;
1604 GCPRO2 (completion
, last
);
1606 if (NILP (completion
))
1609 temp_echo_area_glyphs (" [No match]");
1614 if (EQ (completion
, Qt
)) /* exact and unique match */
1620 string
= Ffield_string (make_number (ZV
));
1622 /* COMPLETEDP should be true if some completion was done, which
1623 doesn't include simply changing the case of the entered string.
1624 However, for appearance, the string is rewritten if the case
1626 tem
= Fcompare_strings (completion
, Qnil
, Qnil
, string
, Qnil
, Qnil
, Qt
);
1627 completedp
= !EQ (tem
, Qt
);
1629 tem
= Fcompare_strings (completion
, Qnil
, Qnil
, string
, Qnil
, Qnil
, Qnil
);
1631 /* Rewrite the user's input. */
1633 Fdelete_field (make_number (ZV
)); /* Some completion happened */
1634 Finsert (1, &completion
);
1637 /* The case of the string changed, but that's all. We're not
1638 sure whether this is a unique completion or not, so try again
1639 using the real case (this shouldn't recurse again, because
1640 the next time try-completion will return either `t' or the
1644 return do_completion ();
1648 /* It did find a match. Do we match some possibility exactly now? */
1649 tem
= test_completion (Ffield_string (make_number (ZV
)));
1652 /* not an exact match */
1656 else if (!NILP (Vcompletion_auto_help
))
1657 Fminibuffer_completion_help ();
1659 temp_echo_area_glyphs (" [Next char not unique]");
1662 else if (completedp
)
1667 /* If the last exact completion and this one were the same,
1668 it means we've already given a "Complete but not unique"
1669 message and the user's hit TAB again, so now we give him help. */
1670 last_exact_completion
= completion
;
1673 tem
= Ffield_string (make_number (ZV
));
1674 if (!NILP (Fequal (tem
, last
)))
1675 Fminibuffer_completion_help ();
1681 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1684 assoc_for_completion (key
, list
)
1685 register Lisp_Object key
;
1688 register Lisp_Object tail
;
1690 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1692 register Lisp_Object elt
, tem
, thiscar
;
1694 if (!CONSP (elt
)) continue;
1695 thiscar
= Fcar (elt
);
1696 if (!STRINGP (thiscar
))
1698 tem
= Fcompare_strings (thiscar
, make_number (0), Qnil
,
1699 key
, make_number (0), Qnil
,
1700 completion_ignore_case
? Qt
: Qnil
);
1708 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1709 "Complete the minibuffer contents as far as possible.\n\
1710 Return nil if there is no valid completion, else t.\n\
1711 If no characters can be completed, display a list of possible completions.\n\
1712 If you repeat this command after it displayed such a list,\n\
1713 scroll the window of possible completions.")
1717 Lisp_Object window
, tem
;
1719 /* If the previous command was not this,
1720 mark the completion buffer obsolete. */
1721 if (! EQ (current_kboard
->Vlast_command
, Vthis_command
))
1722 Vminibuf_scroll_window
= Qnil
;
1724 window
= Vminibuf_scroll_window
;
1725 /* If there's a fresh completion window with a live buffer,
1726 and this command is repeated, scroll that window. */
1727 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1728 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1730 struct buffer
*obuf
= current_buffer
;
1732 Fset_buffer (XWINDOW (window
)->buffer
);
1733 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
, Qnil
);
1735 /* If end is in view, scroll up to the beginning. */
1736 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1738 /* Else scroll down one screen. */
1739 Fscroll_other_window (Qnil
);
1741 set_buffer_internal (obuf
);
1745 i
= do_completion ();
1753 Fgoto_char (make_number (ZV
));
1754 temp_echo_area_glyphs (" [Sole completion]");
1759 Fgoto_char (make_number (ZV
));
1760 temp_echo_area_glyphs (" [Complete, but not unique]");
1767 /* Subroutines of Fminibuffer_complete_and_exit. */
1769 /* This one is called by internal_condition_case to do the real work. */
1772 complete_and_exit_1 ()
1774 return make_number (do_completion ());
1777 /* This one is called by internal_condition_case if an error happens.
1778 Pretend the current value is an exact match. */
1781 complete_and_exit_2 (ignore
)
1784 return make_number (1);
1787 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1788 Sminibuffer_complete_and_exit
, 0, 0, "",
1789 "If the minibuffer contents is a valid completion then exit.\n\
1790 Otherwise try to complete it. If completion leads to a valid completion,\n\
1791 a repetition of this command will exit.")
1797 /* Allow user to specify null string */
1798 if (XINT (Ffield_beginning (make_number (ZV
), Qnil
)) == ZV
)
1801 if (!NILP (test_completion (Ffield_string (make_number (ZV
)))))
1804 /* Call do_completion, but ignore errors. */
1805 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1806 complete_and_exit_2
);
1816 if (!NILP (Vminibuffer_completion_confirm
))
1818 temp_echo_area_glyphs (" [Confirm]");
1828 return Fthrow (Qexit
, Qnil
);
1832 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1834 "Complete the minibuffer contents at most a single word.\n\
1835 After one word is completed as much as possible, a space or hyphen\n\
1836 is added, provided that matches some possible completion.\n\
1837 Return nil if there is no valid completion, else t.")
1840 Lisp_Object completion
, tem
, tem1
;
1841 register int i
, i_byte
;
1842 register unsigned char *completion_string
;
1843 struct gcpro gcpro1
, gcpro2
;
1844 int prompt_end_charpos
;
1846 /* We keep calling Fbuffer_string rather than arrange for GC to
1847 hold onto a pointer to one of the strings thus made. */
1849 completion
= Ftry_completion (Ffield_string (make_number (ZV
)),
1850 Vminibuffer_completion_table
,
1851 Vminibuffer_completion_predicate
);
1852 if (NILP (completion
))
1855 temp_echo_area_glyphs (" [No match]");
1858 if (EQ (completion
, Qt
))
1861 #if 0 /* How the below code used to look, for reference. */
1862 tem
= Ffield_string (make_number (ZV
));
1863 b
= XSTRING (tem
)->data
;
1864 i
= ZV
- 1 - XSTRING (completion
)->size
;
1865 p
= XSTRING (completion
)->data
;
1867 0 <= scmp (b
, p
, ZV
- 1))
1870 /* Set buffer to longest match of buffer tail and completion head. */
1871 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1873 del_range (1, i
+ 1);
1876 #else /* Rewritten code */
1878 int buffer_nchars
, completion_nchars
;
1880 CHECK_STRING (completion
, 0);
1881 tem
= Ffield_string (make_number (ZV
));
1882 GCPRO2 (completion
, tem
);
1883 /* If reading a file name,
1884 expand any $ENVVAR refs in the buffer and in TEM. */
1885 if (! NILP (Vminibuffer_completing_file_name
))
1887 Lisp_Object substituted
;
1888 substituted
= Fsubstitute_in_file_name (tem
);
1889 if (! EQ (substituted
, tem
))
1892 Fdelete_field (make_number (ZV
));
1893 insert_from_string (tem
, 0, 0, XSTRING (tem
)->size
,
1894 STRING_BYTES (XSTRING (tem
)), 0);
1897 buffer_nchars
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1898 completion_nchars
= XSTRING (completion
)->size
;
1899 i
= buffer_nchars
- completion_nchars
;
1902 (tem1
= Fcompare_strings (tem
, make_number (0),
1903 make_number (buffer_nchars
),
1904 completion
, make_number (0),
1905 make_number (buffer_nchars
),
1906 completion_ignore_case
? Qt
: Qnil
),
1911 /* Set buffer to longest match of buffer tail and completion head. */
1917 tem1
= Fcompare_strings (tem
, make_number (start_pos
), Qnil
,
1918 completion
, make_number (0),
1919 make_number (buffer_nchars
),
1920 completion_ignore_case
? Qt
: Qnil
);
1927 del_range (1, i
+ 1);
1928 SET_PT_BOTH (ZV
, ZV_BYTE
);
1932 #endif /* Rewritten code */
1934 prompt_end_charpos
= XINT (Ffield_beginning (make_number (ZV
), Qnil
));
1937 int prompt_end_bytepos
;
1938 prompt_end_bytepos
= CHAR_TO_BYTE (prompt_end_charpos
);
1939 i
= ZV
- prompt_end_charpos
;
1940 i_byte
= ZV_BYTE
- prompt_end_bytepos
;
1943 /* If completion finds next char not unique,
1944 consider adding a space or a hyphen. */
1945 if (i
== XSTRING (completion
)->size
)
1947 GCPRO1 (completion
);
1948 tem
= Ftry_completion (concat2 (Ffield_string (make_number (ZV
)), build_string (" ")),
1949 Vminibuffer_completion_table
,
1950 Vminibuffer_completion_predicate
);
1957 GCPRO1 (completion
);
1959 Ftry_completion (concat2 (Ffield_string (make_number (ZV
)), build_string ("-")),
1960 Vminibuffer_completion_table
,
1961 Vminibuffer_completion_predicate
);
1969 /* Now find first word-break in the stuff found by completion.
1970 i gets index in string of where to stop completing. */
1973 int bytes
= STRING_BYTES (XSTRING (completion
));
1974 completion_string
= XSTRING (completion
)->data
;
1975 for (; i_byte
< STRING_BYTES (XSTRING (completion
)); i_byte
+= len
, i
++)
1977 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i_byte
,
1980 if (SYNTAX (c
) != Sword
)
1989 /* If got no characters, print help for user. */
1991 if (i
== ZV
- prompt_end_charpos
)
1993 if (!NILP (Vcompletion_auto_help
))
1994 Fminibuffer_completion_help ();
1998 /* Otherwise insert in minibuffer the chars we got */
2000 Fdelete_field (make_number (ZV
));
2001 insert_from_string (completion
, 0, 0, i
, i_byte
, 1);
2005 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
2007 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
2008 Each element may be just a symbol or string\n\
2009 or may be a list of two strings to be printed as if concatenated.\n\
2010 `standard-output' must be a buffer.\n\
2011 The actual completion alternatives, as inserted, are given `mouse-face'\n\
2012 properties of `highlight'.\n\
2013 At the end, this runs the normal hook `completion-setup-hook'.\n\
2014 It can find the completion buffer in `standard-output'.")
2016 Lisp_Object completions
;
2018 Lisp_Object tail
, elt
;
2021 struct gcpro gcpro1
, gcpro2
;
2022 struct buffer
*old
= current_buffer
;
2025 /* Note that (when it matters) every variable
2026 points to a non-string that is pointed to by COMPLETIONS,
2027 except for ELT. ELT can be pointing to a string
2028 when terpri or Findent_to calls a change hook. */
2030 GCPRO2 (completions
, elt
);
2032 if (BUFFERP (Vstandard_output
))
2033 set_buffer_internal (XBUFFER (Vstandard_output
));
2035 if (NILP (completions
))
2036 write_string ("There are no possible completions of what you have typed.",
2040 write_string ("Possible completions are:", -1);
2041 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
2043 Lisp_Object tem
, string
;
2045 Lisp_Object startpos
, endpos
;
2050 /* Compute the length of this element. */
2054 CHECK_STRING (tem
, 0);
2055 length
= XSTRING (tem
)->size
;
2057 tem
= Fcar (XCDR (elt
));
2058 CHECK_STRING (tem
, 0);
2059 length
+= XSTRING (tem
)->size
;
2063 CHECK_STRING (elt
, 0);
2064 length
= XSTRING (elt
)->size
;
2067 /* This does a bad job for narrower than usual windows.
2068 Sadly, the window it will appear in is not known
2069 until after the text has been made. */
2071 if (BUFFERP (Vstandard_output
))
2072 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2074 /* If the previous completion was very wide,
2075 or we have two on this line already,
2076 don't put another on the same line. */
2077 if (column
> 33 || first
2078 /* If this is really wide, don't put it second on a line. */
2079 || (column
> 0 && length
> 45))
2084 /* Otherwise advance to column 35. */
2087 if (BUFFERP (Vstandard_output
))
2089 tem
= Findent_to (make_number (35), make_number (2));
2091 column
= XINT (tem
);
2097 write_string (" ", -1);
2100 while (column
< 35);
2104 if (BUFFERP (Vstandard_output
))
2106 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2107 Fset_text_properties (startpos
, endpos
,
2108 Qnil
, Vstandard_output
);
2111 /* Output this element.
2112 If necessary, convert it to unibyte or to multibyte first. */
2114 string
= Fcar (elt
);
2117 if (NILP (current_buffer
->enable_multibyte_characters
)
2118 && STRING_MULTIBYTE (string
))
2119 string
= Fstring_make_unibyte (string
);
2120 else if (!NILP (current_buffer
->enable_multibyte_characters
)
2121 && !STRING_MULTIBYTE (string
))
2122 string
= Fstring_make_multibyte (string
);
2124 if (BUFFERP (Vstandard_output
))
2126 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2128 Fprinc (string
, Qnil
);
2130 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2132 Fput_text_property (startpos
, endpos
,
2133 Qmouse_face
, intern ("highlight"),
2138 Fprinc (string
, Qnil
);
2141 /* Output the annotation for this element. */
2144 if (BUFFERP (Vstandard_output
))
2146 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2148 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2150 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2152 Fset_text_properties (startpos
, endpos
, Qnil
,
2157 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2162 /* Update COLUMN for what we have output. */
2165 /* If output is to a buffer, recompute COLUMN in a way
2166 that takes account of character widths. */
2167 if (BUFFERP (Vstandard_output
))
2169 tem
= Fcurrent_column ();
2170 column
= XINT (tem
);
2179 if (BUFFERP (Vstandard_output
))
2180 set_buffer_internal (old
);
2182 if (!NILP (Vrun_hooks
))
2183 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
2188 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
2190 "Display a list of possible completions of the current minibuffer contents.")
2193 Lisp_Object completions
;
2195 message ("Making completion list...");
2196 completions
= Fall_completions (Ffield_string (make_number (ZV
)),
2197 Vminibuffer_completion_table
,
2198 Vminibuffer_completion_predicate
,
2200 clear_message (1, 0);
2202 if (NILP (completions
))
2205 temp_echo_area_glyphs (" [No completions]");
2208 internal_with_output_to_temp_buffer ("*Completions*",
2209 Fdisplay_completion_list
,
2210 Fsort (completions
, Qstring_lessp
));
2214 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
2215 "Terminate minibuffer input.")
2218 if (INTEGERP (last_command_char
))
2219 internal_self_insert (XINT (last_command_char
), 0);
2223 return Fthrow (Qexit
, Qnil
);
2226 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
2227 "Terminate this minibuffer argument.")
2230 return Fthrow (Qexit
, Qnil
);
2233 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
2234 "Return current depth of activations of minibuffer, a nonnegative integer.")
2237 return make_number (minibuf_level
);
2240 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
2241 "Return the prompt string of the currently-active minibuffer.\n\
2242 If no minibuffer is active, return nil.")
2245 return Fcopy_sequence (minibuf_prompt
);
2249 /* Temporarily display the string M at the end of the current
2250 minibuffer contents. This is used to display things like
2251 "[No Match]" when the user requests a completion for a prefix
2252 that has no possible completions, and other quick, unobtrusive
2256 temp_echo_area_glyphs (m
)
2260 int osize_byte
= ZV_BYTE
;
2262 int opoint_byte
= PT_BYTE
;
2263 Lisp_Object oinhibit
;
2264 oinhibit
= Vinhibit_quit
;
2266 /* Clear out any old echo-area message to make way for our new thing. */
2269 SET_PT_BOTH (osize
, osize_byte
);
2271 SET_PT_BOTH (opoint
, opoint_byte
);
2273 Fsit_for (make_number (2), Qnil
, Qnil
);
2274 del_range_both (osize
, osize_byte
, ZV
, ZV_BYTE
, 1);
2275 SET_PT_BOTH (opoint
, opoint_byte
);
2276 if (!NILP (Vquit_flag
))
2279 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
2281 Vinhibit_quit
= oinhibit
;
2284 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
2286 "Temporarily display STRING at the end of the minibuffer.\n\
2287 The text is displayed for two seconds,\n\
2288 or until the next input event arrives, whichever comes first.")
2292 temp_echo_area_glyphs (XSTRING (string
)->data
);
2297 init_minibuf_once ()
2299 Vminibuffer_list
= Qnil
;
2300 staticpro (&Vminibuffer_list
);
2307 minibuf_prompt
= Qnil
;
2308 staticpro (&minibuf_prompt
);
2310 minibuf_save_list
= Qnil
;
2311 staticpro (&minibuf_save_list
);
2313 Qread_file_name_internal
= intern ("read-file-name-internal");
2314 staticpro (&Qread_file_name_internal
);
2316 Qminibuffer_default
= intern ("minibuffer-default");
2317 staticpro (&Qminibuffer_default
);
2318 Fset (Qminibuffer_default
, Qnil
);
2320 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
2321 staticpro (&Qminibuffer_completion_table
);
2323 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
2324 staticpro (&Qminibuffer_completion_confirm
);
2326 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
2327 staticpro (&Qminibuffer_completion_predicate
);
2329 staticpro (&last_exact_completion
);
2330 last_exact_completion
= Qnil
;
2332 staticpro (&last_minibuf_string
);
2333 last_minibuf_string
= Qnil
;
2335 Quser_variable_p
= intern ("user-variable-p");
2336 staticpro (&Quser_variable_p
);
2338 Qminibuffer_history
= intern ("minibuffer-history");
2339 staticpro (&Qminibuffer_history
);
2341 Qbuffer_name_history
= intern ("buffer-name-history");
2342 staticpro (&Qbuffer_name_history
);
2343 Fset (Qbuffer_name_history
, Qnil
);
2345 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2346 staticpro (&Qminibuffer_setup_hook
);
2348 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2349 staticpro (&Qminibuffer_exit_hook
);
2351 Qhistory_length
= intern ("history-length");
2352 staticpro (&Qhistory_length
);
2354 Qcurrent_input_method
= intern ("current-input-method");
2355 staticpro (&Qcurrent_input_method
);
2357 Qactivate_input_method
= intern ("activate-input-method");
2358 staticpro (&Qactivate_input_method
);
2360 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2361 "If this is non-nil, `read-buffer' does its work by calling this function.");
2362 Vread_buffer_function
= Qnil
;
2364 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2365 "Normal hook run just after entry to minibuffer.");
2366 Vminibuffer_setup_hook
= Qnil
;
2368 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2369 "Normal hook run just after exit from minibuffer.");
2370 Vminibuffer_exit_hook
= Qnil
;
2372 DEFVAR_LISP ("history-length", &Vhistory_length
,
2373 "*Maximum length for history lists before truncation takes place.\n\
2374 A number means that length; t means infinite. Truncation takes place\n\
2375 just after a new element is inserted. Setting the history-length\n\
2376 property of a history variable overrides this default.");
2377 XSETFASTINT (Vhistory_length
, 30);
2379 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help
,
2380 "*Non-nil means automatically provide help for invalid completion input.");
2381 Vcompletion_auto_help
= Qt
;
2383 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2384 "Non-nil means don't consider case significant in completion.");
2385 completion_ignore_case
= 0;
2387 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2388 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2389 This variable makes a difference whenever the minibuffer window is active.");
2390 enable_recursive_minibuffers
= 0;
2392 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2393 "Alist or obarray used for completion in the minibuffer.\n\
2394 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2396 The value may alternatively be a function, which is given three arguments:\n\
2397 STRING, the current buffer contents;\n\
2398 PREDICATE, the predicate for filtering possible matches;\n\
2399 CODE, which says what kind of things to do.\n\
2400 CODE can be nil, t or `lambda'.\n\
2401 nil means to return the best completion of STRING, or nil if there is none.\n\
2402 t means to return a list of all possible completions of STRING.\n\
2403 `lambda' means to return t if STRING is a valid completion as it stands.");
2404 Vminibuffer_completion_table
= Qnil
;
2406 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2407 "Within call to `completing-read', this holds the PREDICATE argument.");
2408 Vminibuffer_completion_predicate
= Qnil
;
2410 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2411 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2412 Vminibuffer_completion_confirm
= Qnil
;
2414 DEFVAR_LISP ("minibuffer-completing-file-name",
2415 &Vminibuffer_completing_file_name
,
2416 "Non-nil means completing file names.");
2417 Vminibuffer_completing_file_name
= Qnil
;
2419 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2420 "Value that `help-form' takes on inside the minibuffer.");
2421 Vminibuffer_help_form
= Qnil
;
2423 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2424 "History list symbol to add minibuffer values to.\n\
2425 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2427 (set minibuffer-history-variable\n\
2428 (cons STRING (symbol-value minibuffer-history-variable)))");
2429 XSETFASTINT (Vminibuffer_history_variable
, 0);
2431 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2432 "Current position of redoing in the history list.");
2433 Vminibuffer_history_position
= Qnil
;
2435 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2436 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2437 Some uses of the echo area also raise that frame (since they use it too).");
2438 minibuffer_auto_raise
= 0;
2440 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2441 "List of regexps that should restrict possible completions.");
2442 Vcompletion_regexp_list
= Qnil
;
2444 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2445 &minibuffer_allow_text_properties
,
2446 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2447 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2448 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2449 with completion; they always discard text properties.");
2450 minibuffer_allow_text_properties
= 0;
2452 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties
,
2453 "Text properties that are added to minibuffer prompts.\n\
2454 These are in addition to the basic `field' property, and stickiness\n\
2456 /* We use `intern' here instead of Qread_only to avoid
2457 initialization-order problems. */
2458 Vminibuffer_prompt_properties
2459 = Fcons (intern ("read-only"), Fcons (Qt
, Qnil
));
2461 defsubr (&Sset_minibuffer_window
);
2462 defsubr (&Sread_from_minibuffer
);
2463 defsubr (&Seval_minibuffer
);
2464 defsubr (&Sread_minibuffer
);
2465 defsubr (&Sread_string
);
2466 defsubr (&Sread_command
);
2467 defsubr (&Sread_variable
);
2468 defsubr (&Sread_buffer
);
2469 defsubr (&Sread_no_blanks_input
);
2470 defsubr (&Sminibuffer_depth
);
2471 defsubr (&Sminibuffer_prompt
);
2473 defsubr (&Stry_completion
);
2474 defsubr (&Sall_completions
);
2475 defsubr (&Scompleting_read
);
2476 defsubr (&Sminibuffer_complete
);
2477 defsubr (&Sminibuffer_complete_word
);
2478 defsubr (&Sminibuffer_complete_and_exit
);
2479 defsubr (&Sdisplay_completion_list
);
2480 defsubr (&Sminibuffer_completion_help
);
2482 defsubr (&Sself_insert_and_exit
);
2483 defsubr (&Sexit_minibuffer
);
2485 defsubr (&Sminibuffer_message
);
2491 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2492 "abort-recursive-edit");
2493 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2495 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2498 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2499 "abort-recursive-edit");
2500 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2502 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2505 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2507 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2509 initial_define_key (Vminibuffer_local_ns_map
, '?',
2510 "self-insert-and-exit");
2512 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2513 "abort-recursive-edit");
2514 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2516 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2519 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2520 "minibuffer-complete");
2521 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2522 "minibuffer-complete-word");
2523 initial_define_key (Vminibuffer_local_completion_map
, '?',
2524 "minibuffer-completion-help");
2526 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2527 "abort-recursive-edit");
2528 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2529 "minibuffer-complete-and-exit");
2530 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2531 "minibuffer-complete-and-exit");
2532 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2533 "minibuffer-complete");
2534 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2535 "minibuffer-complete-word");
2536 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2537 "minibuffer-completion-help");