1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
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"
35 #define min(a, b) ((a) < (b) ? (a) : (b))
39 /* List of buffers for use as minibuffers.
40 The first element of the list is used for the outermost minibuffer
41 invocation, the next element is used for a recursive minibuffer
42 invocation, etc. The list is extended at the end as deeper
43 minibuffer recursions are encountered. */
45 Lisp_Object Vminibuffer_list
;
47 /* Data to remember during recursive minibuffer invocations */
49 Lisp_Object minibuf_save_list
;
51 /* Depth in minibuffer invocations. */
55 /* Nonzero means display completion help for invalid input. */
59 /* The maximum length of a minibuffer history. */
61 Lisp_Object Qhistory_length
, Vhistory_length
;
63 /* Fread_minibuffer leaves the input here as a string. */
65 Lisp_Object last_minibuf_string
;
67 /* Nonzero means let functions called when within a minibuffer
68 invoke recursive minibuffers (to read arguments, or whatever) */
70 int enable_recursive_minibuffers
;
72 /* Nonzero means don't ignore text properties
73 in Fread_from_minibuffer. */
75 int minibuffer_allow_text_properties
;
77 /* help-form is bound to this while in the minibuffer. */
79 Lisp_Object Vminibuffer_help_form
;
81 /* Variable which is the history list to add minibuffer values to. */
83 Lisp_Object Vminibuffer_history_variable
;
85 /* Current position in the history list (adjusted by M-n and M-p). */
87 Lisp_Object Vminibuffer_history_position
;
89 Lisp_Object Qminibuffer_history
, Qbuffer_name_history
;
91 Lisp_Object Qread_file_name_internal
;
93 /* Normal hooks for entry to and exit from minibuffer. */
95 Lisp_Object Qminibuffer_setup_hook
, Vminibuffer_setup_hook
;
96 Lisp_Object Qminibuffer_exit_hook
, Vminibuffer_exit_hook
;
98 /* Function to call to read a buffer name. */
99 Lisp_Object Vread_buffer_function
;
101 /* Nonzero means completion ignores case. */
103 int completion_ignore_case
;
105 /* List of regexps that should restrict possible completions. */
107 Lisp_Object Vcompletion_regexp_list
;
109 /* Nonzero means raise the minibuffer frame when the minibuffer
112 int minibuffer_auto_raise
;
114 /* If last completion attempt reported "Complete but not unique"
115 then this is the string completed then; otherwise this is nil. */
117 static Lisp_Object last_exact_completion
;
119 /* Non-nil means it is the window for C-M-v to scroll
120 when the minibuffer is selected. */
122 extern Lisp_Object Vminibuf_scroll_window
;
124 extern Lisp_Object Voverriding_local_map
;
126 Lisp_Object Quser_variable_p
;
128 Lisp_Object Qminibuffer_default
;
130 Lisp_Object Qcurrent_input_method
, Qactivate_input_method
;
132 extern Lisp_Object Qmouse_face
;
134 extern Lisp_Object Qfield
;
136 /* Put minibuf on currently selected frame's minibuffer.
137 We do this whenever the user starts a new minibuffer
138 or when a minibuffer exits. */
141 choose_minibuf_frame ()
143 if (FRAMEP (selected_frame
)
144 && FRAME_LIVE_P (XFRAME (selected_frame
))
145 && !EQ (minibuf_window
, XFRAME (selected_frame
)->minibuffer_window
))
147 struct frame
*sf
= XFRAME (selected_frame
);
150 /* I don't think that any frames may validly have a null minibuffer
152 if (NILP (sf
->minibuffer_window
))
155 /* Under X, we come here with minibuf_window being the
156 minibuffer window of the unused termcap window created in
157 init_window_once. That window doesn't have a buffer. */
158 buffer
= XWINDOW (minibuf_window
)->buffer
;
159 if (BUFFERP (buffer
))
160 Fset_window_buffer (sf
->minibuffer_window
, buffer
);
161 minibuf_window
= sf
->minibuffer_window
;
164 /* Make sure no other frame has a minibuffer as its selected window,
165 because the text would not be displayed in it, and that would be
166 confusing. Only allow the selected frame to do this,
167 and that only if the minibuffer is active. */
169 Lisp_Object tail
, frame
;
171 FOR_EACH_FRAME (tail
, frame
)
172 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame
))))
173 && !(EQ (frame
, selected_frame
)
174 && minibuf_level
> 0))
175 Fset_frame_selected_window (frame
, Fframe_first_window (frame
));
180 choose_minibuf_frame_1 (ignore
)
183 choose_minibuf_frame ();
187 DEFUN ("set-minibuffer-window", Fset_minibuffer_window
,
188 Sset_minibuffer_window
, 1, 1, 0,
189 "Specify which minibuffer window to use for the minibuffer.\n\
190 This effects where the minibuffer is displayed if you put text in it\n\
191 without invoking the usual minibuffer commands.")
195 CHECK_WINDOW (window
, 1);
196 if (! MINI_WINDOW_P (XWINDOW (window
)))
197 error ("Window is not a minibuffer window");
199 minibuf_window
= window
;
205 /* Actual minibuffer invocation. */
207 static Lisp_Object read_minibuf_unwind
P_ ((Lisp_Object
));
208 static Lisp_Object read_minibuf
P_ ((Lisp_Object
, Lisp_Object
,
209 Lisp_Object
, Lisp_Object
,
211 Lisp_Object
, Lisp_Object
,
213 static Lisp_Object read_minibuf_noninteractive
P_ ((Lisp_Object
, Lisp_Object
,
214 Lisp_Object
, Lisp_Object
,
216 Lisp_Object
, Lisp_Object
,
218 static Lisp_Object string_to_object
P_ ((Lisp_Object
, Lisp_Object
));
221 /* Read a Lisp object from VAL and return it. If VAL is an empty
222 string, and DEFALT is a string, read from DEFALT instead of VAL. */
225 string_to_object (val
, defalt
)
226 Lisp_Object val
, defalt
;
228 struct gcpro gcpro1
, gcpro2
;
229 Lisp_Object expr_and_pos
;
232 GCPRO2 (val
, defalt
);
234 if (STRINGP (val
) && XSTRING (val
)->size
== 0
238 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
239 pos
= XINT (Fcdr (expr_and_pos
));
240 if (pos
!= XSTRING (val
)->size
)
242 /* Ignore trailing whitespace; any other trailing junk
245 pos
= string_char_to_byte (val
, pos
);
246 for (i
= pos
; i
< STRING_BYTES (XSTRING (val
)); i
++)
248 int c
= XSTRING (val
)->data
[i
];
249 if (c
!= ' ' && c
!= '\t' && c
!= '\n')
250 error ("Trailing garbage following expression");
254 val
= Fcar (expr_and_pos
);
255 RETURN_UNGCPRO (val
);
259 /* Like read_minibuf but reading from stdin. This function is called
260 from read_minibuf to do the job if noninteractive. */
263 read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
, expflag
,
264 histvar
, histpos
, defalt
, allow_props
,
265 inherit_input_method
)
269 Lisp_Object backup_n
;
275 int inherit_input_method
;
281 fprintf (stdout
, "%s", XSTRING (prompt
)->data
);
286 line
= (char *) xmalloc (size
* sizeof *line
);
287 while ((s
= fgets (line
+ len
, size
- len
, stdin
)) != NULL
288 && (len
= strlen (line
),
289 len
== size
- 1 && line
[len
- 1] != '\n'))
292 line
= (char *) xrealloc (line
, size
);
299 if (len
> 0 && line
[len
- 1] == '\n')
302 val
= build_string (line
);
308 error ("Error reading from stdin");
311 /* If Lisp form desired instead of string, parse it. */
313 val
= string_to_object (val
, defalt
);
319 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
320 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
321 prompting with PROMPT (a string), using history list HISTVAR
322 with initial position HISTPOS. (BACKUP_N should be <= 0.)
324 Normally return the result as a string (the text that was read),
325 but if EXPFLAG is nonzero, read it and return the object read.
326 If HISTVAR is given, save the value read on that history only if it doesn't
327 match the front of that history list exactly. The value is pushed onto
328 the list as the string that was read.
330 DEFALT specifies te default value for the sake of history commands.
332 If ALLOW_PROPS is nonzero, we do not throw away text properties.
334 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
335 current input method. */
338 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
339 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
343 Lisp_Object backup_n
;
349 int inherit_input_method
;
352 int count
= specpdl_ptr
- specpdl
;
353 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
354 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
355 Lisp_Object enable_multibyte
;
356 extern Lisp_Object Qread_only
, Qfront_sticky
;
357 extern Lisp_Object Qrear_nonsticky
;
359 specbind (Qminibuffer_default
, defalt
);
361 single_kboard_state ();
364 ambient_dir
= current_buffer
->directory
;
366 enable_multibyte
= Qnil
;
368 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
369 store them away before we can GC. Don't need to protect
370 BACKUP_N because we use the value only if it is an integer. */
371 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
373 if (!STRINGP (prompt
))
374 prompt
= build_string ("");
376 if (!enable_recursive_minibuffers
377 && minibuf_level
> 0)
379 if (EQ (selected_window
, minibuf_window
))
380 error ("Command attempted to use minibuffer while in minibuffer");
382 /* If we're in another window, cancel the minibuffer that's active. */
384 build_string ("Command attempted to use minibuffer while in minibuffer"));
388 return read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
,
389 expflag
, histvar
, histpos
, defalt
,
390 allow_props
, inherit_input_method
);
392 /* Choose the minibuffer window and frame, and take action on them. */
394 choose_minibuf_frame ();
396 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
398 record_unwind_protect (Fset_window_configuration
,
399 Fcurrent_window_configuration (Qnil
));
401 /* If the minibuffer window is on a different frame, save that
402 frame's configuration too. */
403 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
404 if (!EQ (mini_frame
, selected_frame
))
405 record_unwind_protect (Fset_window_configuration
,
406 Fcurrent_window_configuration (mini_frame
));
408 /* If the minibuffer is on an iconified or invisible frame,
409 make it visible now. */
410 Fmake_frame_visible (mini_frame
);
412 if (minibuffer_auto_raise
)
413 Fraise_frame (mini_frame
);
415 /* We have to do this after saving the window configuration
416 since that is what restores the current buffer. */
418 /* Arrange to restore a number of minibuffer-related variables.
419 We could bind each variable separately, but that would use lots of
422 = Fcons (Voverriding_local_map
,
423 Fcons (minibuf_window
, minibuf_save_list
));
425 = Fcons (minibuf_prompt
,
426 Fcons (make_number (minibuf_prompt_width
),
428 Fcons (Vcurrent_prefix_arg
,
429 Fcons (Vminibuffer_history_position
,
430 Fcons (Vminibuffer_history_variable
,
431 minibuf_save_list
))))));
433 record_unwind_protect (read_minibuf_unwind
, Qnil
);
436 /* Now that we can restore all those variables, start changing them. */
438 minibuf_prompt_width
= 0;
439 minibuf_prompt
= Fcopy_sequence (prompt
);
440 Vminibuffer_history_position
= histpos
;
441 Vminibuffer_history_variable
= histvar
;
442 Vhelp_form
= Vminibuffer_help_form
;
444 if (inherit_input_method
)
446 /* `current-input-method' is buffer local. So, remeber it in
447 INPUT_METHOD before changing the current buffer. */
448 input_method
= Fsymbol_value (Qcurrent_input_method
);
449 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
452 /* Switch to the minibuffer. */
454 minibuffer
= get_minibuffer (minibuf_level
);
455 Fset_buffer (minibuffer
);
457 /* The current buffer's default directory is usually the right thing
458 for our minibuffer here. However, if you're typing a command at
459 a minibuffer-only frame when minibuf_level is zero, then buf IS
460 the current_buffer, so reset_buffer leaves buf's default
461 directory unchanged. This is a bummer when you've just started
462 up Emacs and buf's default directory is Qnil. Here's a hack; can
463 you think of something better to do? Find another buffer with a
464 better directory, and use that one instead. */
465 if (STRINGP (ambient_dir
))
466 current_buffer
->directory
= ambient_dir
;
469 Lisp_Object buf_list
;
471 for (buf_list
= Vbuffer_alist
;
473 buf_list
= XCDR (buf_list
))
475 Lisp_Object other_buf
;
477 other_buf
= XCDR (XCAR (buf_list
));
478 if (STRINGP (XBUFFER (other_buf
)->directory
))
480 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
486 if (!EQ (mini_frame
, selected_frame
))
487 Fredirect_frame_focus (selected_frame
, mini_frame
);
489 Vminibuf_scroll_window
= selected_window
;
490 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
491 Fselect_window (minibuf_window
);
492 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
494 Fmake_local_variable (Qprint_escape_newlines
);
495 print_escape_newlines
= 1;
497 /* Erase the buffer. */
499 int count1
= specpdl_ptr
- specpdl
;
500 specbind (Qinhibit_read_only
, Qt
);
502 unbind_to (count1
, Qnil
);
505 if (!NILP (current_buffer
->enable_multibyte_characters
)
506 && ! STRING_MULTIBYTE (minibuf_prompt
))
507 minibuf_prompt
= Fstring_make_multibyte (minibuf_prompt
);
509 /* Insert the prompt, record where it ends. */
510 Finsert (1, &minibuf_prompt
);
513 Fput_text_property (make_number (BEG
), make_number (PT
),
514 Qfront_sticky
, Qt
, Qnil
);
515 Fput_text_property (make_number (BEG
), make_number (PT
),
516 Qrear_nonsticky
, Qt
, Qnil
);
517 Fput_text_property (make_number (BEG
), make_number (PT
),
519 Fput_text_property (make_number (BEG
), make_number (PT
),
520 Qread_only
, Qt
, Qnil
);
523 minibuf_prompt_width
= current_column ();
525 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
526 if (inherit_input_method
)
527 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
529 /* Put in the initial input. */
532 Finsert (1, &initial
);
533 if (INTEGERP (backup_n
))
534 Fforward_char (backup_n
);
537 clear_message (1, 1);
538 current_buffer
->keymap
= map
;
540 /* Turn on an input method stored in INPUT_METHOD if any. */
541 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
542 call1 (Qactivate_input_method
, input_method
);
544 /* Run our hook, but not if it is empty.
545 (run-hooks would do nothing if it is empty,
546 but it's important to save time here in the usual case). */
547 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
548 && !NILP (Vrun_hooks
))
549 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
553 /* If cursor is on the minibuffer line,
554 show the user we have exited by putting it in column 0. */
555 if (XWINDOW (minibuf_window
)->cursor
.vpos
>= 0
558 XWINDOW (minibuf_window
)->cursor
.hpos
= 0;
559 XWINDOW (minibuf_window
)->cursor
.x
= 0;
560 XWINDOW (minibuf_window
)->must_be_updated_p
= 1;
561 update_frame (XFRAME (selected_frame
), 1, 1);
562 if (rif
&& rif
->flush_display
)
563 rif
->flush_display (XFRAME (XWINDOW (minibuf_window
)->frame
));
566 /* Make minibuffer contents into a string. */
567 Fset_buffer (minibuffer
);
569 val
= Ffield_string (make_number (ZV
));
571 val
= Ffield_string_no_properties (make_number (ZV
));
573 /* VAL is the string of minibuffer text. */
575 last_minibuf_string
= val
;
577 /* Add the value to the appropriate history list unless it is empty. */
578 if (XSTRING (val
)->size
!= 0
579 && SYMBOLP (Vminibuffer_history_variable
))
581 /* If the caller wanted to save the value read on a history list,
582 then do so if the value is not already the front of the list. */
585 /* If variable is unbound, make it nil. */
586 if (EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
587 Fset (Vminibuffer_history_variable
, Qnil
);
589 histval
= Fsymbol_value (Vminibuffer_history_variable
);
591 /* The value of the history variable must be a cons or nil. Other
592 values are unacceptable. We silently ignore these values. */
595 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
599 histval
= Fcons (last_minibuf_string
, histval
);
600 Fset (Vminibuffer_history_variable
, histval
);
602 /* Truncate if requested. */
603 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
604 if (NILP (length
)) length
= Vhistory_length
;
605 if (INTEGERP (length
))
607 if (XINT (length
) <= 0)
608 Fset (Vminibuffer_history_variable
, Qnil
);
613 temp
= Fnthcdr (Fsub1 (length
), histval
);
614 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
620 /* If Lisp form desired instead of string, parse it. */
622 val
= string_to_object (val
, defalt
);
624 /* The appropriate frame will get selected
625 in set-window-configuration. */
626 RETURN_UNGCPRO (unbind_to (count
, val
));
629 /* Return a buffer to be used as the minibuffer at depth `depth'.
630 depth = 0 is the lowest allowed argument, and that is the value
631 used for nonrecursive minibuffer invocations */
634 get_minibuffer (depth
)
637 Lisp_Object tail
, num
, buf
;
639 extern Lisp_Object
nconc2 ();
641 XSETFASTINT (num
, depth
);
642 tail
= Fnthcdr (num
, Vminibuffer_list
);
645 tail
= Fcons (Qnil
, Qnil
);
646 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
649 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
651 sprintf (name
, " *Minibuf-%d*", depth
);
652 buf
= Fget_buffer_create (build_string (name
));
654 /* Although the buffer's name starts with a space, undo should be
656 Fbuffer_enable_undo (buf
);
662 int count
= specpdl_ptr
- specpdl
;
664 reset_buffer (XBUFFER (buf
));
665 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
667 Fkill_all_local_variables ();
668 unbind_to (count
, Qnil
);
674 /* This function is called on exiting minibuffer, whether normally or
675 not, and it restores the current window, buffer, etc. */
678 read_minibuf_unwind (data
)
681 Lisp_Object old_deactivate_mark
;
684 /* We are exiting the minibuffer one way or the other,
686 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
687 && !NILP (Vrun_hooks
))
688 safe_run_hooks (Qminibuffer_exit_hook
);
690 /* If this was a recursive minibuffer,
691 tie the minibuffer window back to the outer level minibuffer buffer. */
694 window
= minibuf_window
;
695 /* To keep things predictable, in case it matters, let's be in the
696 minibuffer when we reset the relevant variables. */
697 Fset_buffer (XWINDOW (window
)->buffer
);
699 /* Restore prompt, etc, from outer minibuffer level. */
700 minibuf_prompt
= Fcar (minibuf_save_list
);
701 minibuf_save_list
= Fcdr (minibuf_save_list
);
702 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
703 minibuf_save_list
= Fcdr (minibuf_save_list
);
704 Vhelp_form
= Fcar (minibuf_save_list
);
705 minibuf_save_list
= Fcdr (minibuf_save_list
);
706 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
707 minibuf_save_list
= Fcdr (minibuf_save_list
);
708 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
709 minibuf_save_list
= Fcdr (minibuf_save_list
);
710 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
711 minibuf_save_list
= Fcdr (minibuf_save_list
);
712 Voverriding_local_map
= Fcar (minibuf_save_list
);
713 minibuf_save_list
= Fcdr (minibuf_save_list
);
715 temp
= Fcar (minibuf_save_list
);
716 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
717 minibuf_window
= temp
;
719 minibuf_save_list
= Fcdr (minibuf_save_list
);
721 /* Erase the minibuffer we were using at this level. */
723 int count
= specpdl_ptr
- specpdl
;
724 /* Prevent error in erase-buffer. */
725 specbind (Qinhibit_read_only
, Qt
);
726 old_deactivate_mark
= Vdeactivate_mark
;
728 Vdeactivate_mark
= old_deactivate_mark
;
729 unbind_to (count
, Qnil
);
732 /* When we get to the outmost level, make sure we resize the
733 mini-window back to its normal size. */
734 if (minibuf_level
== 0)
735 resize_mini_window (XWINDOW (window
), 0);
737 /* Make sure minibuffer window is erased, not ignored. */
738 windows_or_buffers_changed
++;
739 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
740 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
745 /* This comment supplies the doc string for read-from-minibuffer,
746 for make-docfile to see. We cannot put this in the real DEFUN
747 due to limits in the Unix cpp.
749 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
750 "Read a string from the minibuffer, prompting with string PROMPT.\n\
751 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
752 to be inserted into the minibuffer before reading input.\n\
753 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
754 is STRING, but point is placed at position POSITION in the minibuffer.\n\
755 Third arg KEYMAP is a keymap to use whilst reading;\n\
756 if omitted or nil, the default is `minibuffer-local-map'.\n\
757 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
758 and return that object:\n\
759 in other words, do `(car (read-from-string INPUT-STRING))'\n\
760 Fifth arg HIST, if non-nil, specifies a history list\n\
761 and optionally the initial position in the list.\n\
762 It can be a symbol, which is the history list variable to use,\n\
763 or it can be a cons cell (HISTVAR . HISTPOS).\n\
764 In that case, HISTVAR is the history list variable to use,\n\
765 and HISTPOS is the initial position (the position in the list\n\
766 which INITIAL-CONTENTS corresponds to).\n\
767 Positions are counted starting from 1 at the beginning of the list.\n\
768 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
769 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
770 if the user enters empty input! It returns the empty string.\n\
771 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
772 the current input method and the setting of enable-multibyte-characters.\n\
773 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
774 then the string which is returned includes whatever text properties\n\
775 were present in the minibuffer. Otherwise the value has no text properties.")
776 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
779 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
780 0 /* See immediately above */)
781 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
782 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
783 Lisp_Object inherit_input_method
;
786 Lisp_Object histvar
, histpos
, position
, val
;
791 CHECK_STRING (prompt
, 0);
792 if (!NILP (initial_contents
))
794 if (CONSP (initial_contents
))
796 position
= Fcdr (initial_contents
);
797 initial_contents
= Fcar (initial_contents
);
799 CHECK_STRING (initial_contents
, 1);
800 if (!NILP (position
))
802 CHECK_NUMBER (position
, 0);
803 /* Convert to distance from end of input. */
804 if (XINT (position
) < 1)
805 /* A number too small means the beginning of the string. */
806 pos
= - XSTRING (initial_contents
)->size
;
808 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
813 keymap
= Vminibuffer_local_map
;
815 keymap
= get_keymap (keymap
);
824 histvar
= Fcar_safe (hist
);
825 histpos
= Fcdr_safe (hist
);
828 histvar
= Qminibuffer_history
;
830 XSETFASTINT (histpos
, 0);
832 GCPRO1 (default_value
);
833 val
= read_minibuf (keymap
, initial_contents
, prompt
,
834 make_number (pos
), !NILP (read
),
835 histvar
, histpos
, default_value
,
836 minibuffer_allow_text_properties
,
837 !NILP (inherit_input_method
));
842 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
843 "Return a Lisp object read using the minibuffer.\n\
844 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
845 is a string to insert in the minibuffer before reading.")
846 (prompt
, initial_contents
)
847 Lisp_Object prompt
, initial_contents
;
849 CHECK_STRING (prompt
, 0);
850 if (!NILP (initial_contents
))
851 CHECK_STRING (initial_contents
, 1);
852 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
853 prompt
, Qnil
, 1, Qminibuffer_history
,
854 make_number (0), Qnil
, 0, 0);
857 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
858 "Return value of Lisp expression read using the minibuffer.\n\
859 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
860 is a string to insert in the minibuffer before reading.")
861 (prompt
, initial_contents
)
862 Lisp_Object prompt
, initial_contents
;
864 return Feval (Fread_minibuffer (prompt
, initial_contents
));
867 /* Functions that use the minibuffer to read various things. */
869 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
870 "Read a string from the minibuffer, prompting with string PROMPT.\n\
871 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
872 The third arg HISTORY, if non-nil, specifies a history list\n\
873 and optionally the initial position in the list.\n\
874 See `read-from-minibuffer' for details of HISTORY argument.\n\
875 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
876 for history commands, and as the value to return if the user enters\n\
878 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
879 the current input method and the setting of enable-multibyte-characters.")
880 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
881 Lisp_Object prompt
, initial_input
, history
, default_value
;
882 Lisp_Object inherit_input_method
;
885 val
= Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
886 Qnil
, history
, default_value
,
887 inherit_input_method
);
888 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
893 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
894 "Read a string from the terminal, not allowing blanks.\n\
895 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
896 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
897 the current input method and the setting of enable-multibyte-characters.")
898 (prompt
, initial
, inherit_input_method
)
899 Lisp_Object prompt
, initial
, inherit_input_method
;
901 CHECK_STRING (prompt
, 0);
902 if (! NILP (initial
))
903 CHECK_STRING (initial
, 1);
905 return read_minibuf (Vminibuffer_local_ns_map
, initial
, prompt
, Qnil
,
906 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
907 !NILP (inherit_input_method
));
910 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
911 "Read the name of a command and return as a symbol.\n\
912 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
913 (prompt
, default_value
)
914 Lisp_Object prompt
, default_value
;
916 Lisp_Object name
, default_string
;
918 if (NILP (default_value
))
919 default_string
= Qnil
;
920 else if (SYMBOLP (default_value
))
921 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
923 default_string
= default_value
;
925 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
926 Qnil
, Qnil
, default_string
, Qnil
);
929 return Fintern (name
, Qnil
);
933 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
934 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
935 Prompts with PROMPT.")
939 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
944 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
945 "Read the name of a user variable and return it as a symbol.\n\
946 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
947 A user variable is one whose documentation starts with a `*' character.")
948 (prompt
, default_value
)
949 Lisp_Object prompt
, default_value
;
951 Lisp_Object name
, default_string
;
953 if (NILP (default_value
))
954 default_string
= Qnil
;
955 else if (SYMBOLP (default_value
))
956 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
958 default_string
= default_value
;
960 name
= Fcompleting_read (prompt
, Vobarray
,
961 Quser_variable_p
, Qt
,
962 Qnil
, Qnil
, default_string
, Qnil
);
965 return Fintern (name
, Qnil
);
968 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
969 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
970 Prompts with PROMPT.\n\
971 Optional second arg DEF is value to return if user enters an empty line.\n\
972 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
973 (prompt
, def
, require_match
)
974 Lisp_Object prompt
, def
, require_match
;
979 def
= XBUFFER (def
)->name
;
981 if (NILP (Vread_buffer_function
))
985 args
[0] = build_string ("%s(default %s) ");
988 prompt
= Fformat (3, args
);
991 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
992 require_match
, Qnil
, Qbuffer_name_history
,
997 args
[0] = Vread_buffer_function
;
1000 args
[3] = require_match
;
1001 return Ffuncall(4, args
);
1006 minibuf_conform_representation (string
, basis
)
1007 Lisp_Object string
, basis
;
1009 if (STRING_MULTIBYTE (string
) == STRING_MULTIBYTE (basis
))
1012 if (STRING_MULTIBYTE (string
))
1013 return Fstring_make_unibyte (string
);
1015 return Fstring_make_multibyte (string
);
1018 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
1019 "Return common substring of all completions of STRING in ALIST.\n\
1020 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1021 All that match are compared together; the longest initial sequence\n\
1022 common to all matches is returned as a string.\n\
1023 If there is no match at all, nil is returned.\n\
1024 For a unique match which is exact, t is returned.\n\
1026 ALIST can be an obarray instead of an alist.\n\
1027 Then the print names of all symbols in the obarray are the possible matches.\n\
1029 ALIST can also be a function to do the completion itself.\n\
1030 It receives three arguments: the values STRING, PREDICATE and nil.\n\
1031 Whatever it returns becomes the value of `try-completion'.\n\
1033 If optional third argument PREDICATE is non-nil,\n\
1034 it is used to test each possible match.\n\
1035 The match is a candidate only if PREDICATE returns non-nil.\n\
1036 The argument given to PREDICATE is the alist element\n\
1037 or the symbol from the obarray.\n\
1038 Additionally to this predicate, `completion-regexp-list'\n\
1039 is used to further constrain the set of candidates.")
1040 (string
, alist
, predicate
)
1041 Lisp_Object string
, alist
, predicate
;
1043 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
1044 /* Size in bytes of BESTMATCH. */
1046 /* These are in bytes, too. */
1047 int compare
, matchsize
;
1048 int list
= CONSP (alist
) || NILP (alist
);
1051 Lisp_Object bucket
, zero
, end
, tem
;
1052 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1054 CHECK_STRING (string
, 0);
1055 if (!list
&& !VECTORP (alist
))
1056 return call3 (alist
, string
, predicate
, Qnil
);
1060 /* If ALIST is not a list, set TAIL just for gc pro. */
1065 obsize
= XVECTOR (alist
)->size
;
1066 bucket
= XVECTOR (alist
)->contents
[index
];
1071 /* Get the next element of the alist or obarray. */
1072 /* Exit the loop if the elements are all used up. */
1073 /* elt gets the alist element or symbol.
1074 eltstring gets the name to check as a completion. */
1081 eltstring
= Fcar (elt
);
1086 if (XFASTINT (bucket
) != 0)
1089 eltstring
= Fsymbol_name (elt
);
1090 if (XSYMBOL (bucket
)->next
)
1091 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1093 XSETFASTINT (bucket
, 0);
1095 else if (++index
>= obsize
)
1099 bucket
= XVECTOR (alist
)->contents
[index
];
1104 /* Is this element a possible completion? */
1106 if (STRINGP (eltstring
)
1107 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1108 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1109 make_number (XSTRING (string
)->size
),
1110 string
, make_number (0), Qnil
,
1111 completion_ignore_case
?Qt
: Qnil
),
1115 Lisp_Object regexps
;
1117 XSETFASTINT (zero
, 0);
1119 /* Ignore this element if it fails to match all the regexps. */
1120 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1121 regexps
= XCDR (regexps
))
1123 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1127 if (CONSP (regexps
))
1130 /* Ignore this element if there is a predicate
1131 and the predicate doesn't like it. */
1133 if (!NILP (predicate
))
1135 if (EQ (predicate
, Qcommandp
))
1136 tem
= Fcommandp (elt
);
1139 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
1140 tem
= call1 (predicate
, elt
);
1143 if (NILP (tem
)) continue;
1146 /* Update computation of how much all possible completions match */
1149 if (NILP (bestmatch
))
1151 bestmatch
= eltstring
;
1152 bestmatchsize
= XSTRING (eltstring
)->size
;
1156 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
1157 tem
= Fcompare_strings (bestmatch
, make_number (0),
1158 make_number (compare
),
1159 eltstring
, make_number (0),
1160 make_number (compare
),
1161 completion_ignore_case
? Qt
: Qnil
);
1163 matchsize
= compare
;
1164 else if (XINT (tem
) < 0)
1165 matchsize
= - XINT (tem
) - 1;
1167 matchsize
= XINT (tem
) - 1;
1170 matchsize
= compare
;
1171 if (completion_ignore_case
)
1173 /* If this is an exact match except for case,
1174 use it as the best match rather than one that is not an
1175 exact match. This way, we get the case pattern
1176 of the actual match. */
1177 if ((matchsize
== XSTRING (eltstring
)->size
1178 && matchsize
< XSTRING (bestmatch
)->size
)
1180 /* If there is more than one exact match ignoring case,
1181 and one of them is exact including case,
1183 /* If there is no exact match ignoring case,
1184 prefer a match that does not change the case
1186 ((matchsize
== XSTRING (eltstring
)->size
)
1188 (matchsize
== XSTRING (bestmatch
)->size
)
1189 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1190 make_number (XSTRING (string
)->size
),
1191 string
, make_number (0),
1195 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1196 make_number (XSTRING (string
)->size
),
1197 string
, make_number (0),
1201 bestmatch
= eltstring
;
1203 bestmatchsize
= matchsize
;
1208 if (NILP (bestmatch
))
1209 return Qnil
; /* No completions found */
1210 /* If we are ignoring case, and there is no exact match,
1211 and no additional text was supplied,
1212 don't change the case of what the user typed. */
1213 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
1214 && XSTRING (bestmatch
)->size
> bestmatchsize
)
1215 return minibuf_conform_representation (string
, bestmatch
);
1217 /* Return t if the supplied string is an exact match (counting case);
1218 it does not require any change to be made. */
1219 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
1220 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1221 make_number (bestmatchsize
),
1222 string
, make_number (0),
1223 make_number (bestmatchsize
),
1228 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1229 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1230 return Fsubstring (bestmatch
, zero
, end
);
1233 /* Compare exactly LEN chars of strings at S1 and S2,
1234 ignoring case if appropriate.
1235 Return -1 if strings match,
1236 else number of chars that match at the beginning. */
1240 register unsigned char *s1
, *s2
;
1243 register int l
= len
;
1245 if (completion_ignore_case
)
1247 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1252 while (l
&& *s1
++ == *s2
++)
1259 int match
= len
- l
;
1261 /* Now *--S1 is the unmatching byte. If it is in the middle of
1262 multi-byte form, we must say that the multi-byte character
1263 there doesn't match. */
1264 while (match
&& *--s1
>= 0xA0) match
--;
1269 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1270 "Search for partial matches to STRING in ALIST.\n\
1271 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1272 The value is a list of all the strings from ALIST that match.\n\
1274 ALIST can be an obarray instead of an alist.\n\
1275 Then the print names of all symbols in the obarray are the possible matches.\n\
1277 ALIST can also be a function to do the completion itself.\n\
1278 It receives three arguments: the values STRING, PREDICATE and t.\n\
1279 Whatever it returns becomes the value of `all-completions'.\n\
1281 If optional third argument PREDICATE is non-nil,\n\
1282 it is used to test each possible match.\n\
1283 The match is a candidate only if PREDICATE returns non-nil.\n\
1284 The argument given to PREDICATE is the alist element\n\
1285 or the symbol from the obarray.\n\
1286 Additionally to this predicate, `completion-regexp-list'\n\
1287 is used to further constrain the set of candidates.\n\
1289 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1290 strings in ALIST that start with a space\n\
1291 are ignored unless STRING itself starts with a space.")
1292 (string
, alist
, predicate
, hide_spaces
)
1293 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1295 Lisp_Object tail
, elt
, eltstring
;
1296 Lisp_Object allmatches
;
1297 int list
= CONSP (alist
) || NILP (alist
);
1299 Lisp_Object bucket
, tem
;
1300 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1302 CHECK_STRING (string
, 0);
1303 if (!list
&& !VECTORP (alist
))
1305 return call3 (alist
, string
, predicate
, Qt
);
1309 /* If ALIST is not a list, set TAIL just for gc pro. */
1314 obsize
= XVECTOR (alist
)->size
;
1315 bucket
= XVECTOR (alist
)->contents
[index
];
1320 /* Get the next element of the alist or obarray. */
1321 /* Exit the loop if the elements are all used up. */
1322 /* elt gets the alist element or symbol.
1323 eltstring gets the name to check as a completion. */
1330 eltstring
= Fcar (elt
);
1335 if (XFASTINT (bucket
) != 0)
1338 eltstring
= Fsymbol_name (elt
);
1339 if (XSYMBOL (bucket
)->next
)
1340 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1342 XSETFASTINT (bucket
, 0);
1344 else if (++index
>= obsize
)
1348 bucket
= XVECTOR (alist
)->contents
[index
];
1353 /* Is this element a possible completion? */
1355 if (STRINGP (eltstring
)
1356 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1357 /* If HIDE_SPACES, reject alternatives that start with space
1358 unless the input starts with space. */
1359 && ((STRING_BYTES (XSTRING (string
)) > 0
1360 && XSTRING (string
)->data
[0] == ' ')
1361 || XSTRING (eltstring
)->data
[0] != ' '
1362 || NILP (hide_spaces
))
1363 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1364 make_number (XSTRING (string
)->size
),
1365 string
, make_number (0),
1366 make_number (XSTRING (string
)->size
),
1367 completion_ignore_case
? Qt
: Qnil
),
1371 Lisp_Object regexps
;
1373 XSETFASTINT (zero
, 0);
1375 /* Ignore this element if it fails to match all the regexps. */
1376 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1377 regexps
= XCDR (regexps
))
1379 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1383 if (CONSP (regexps
))
1386 /* Ignore this element if there is a predicate
1387 and the predicate doesn't like it. */
1389 if (!NILP (predicate
))
1391 if (EQ (predicate
, Qcommandp
))
1392 tem
= Fcommandp (elt
);
1395 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1396 tem
= call1 (predicate
, elt
);
1399 if (NILP (tem
)) continue;
1401 /* Ok => put it on the list. */
1402 allmatches
= Fcons (eltstring
, allmatches
);
1406 return Fnreverse (allmatches
);
1409 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1410 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1411 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1412 Lisp_Object Vminibuffer_completing_file_name
;
1414 /* This comment supplies the doc string for completing-read,
1415 for make-docfile to see. We cannot put this in the real DEFUN
1416 due to limits in the Unix cpp.
1418 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1419 "Read a string in the minibuffer, with completion.\n\
1420 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1421 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1422 TABLE can also be a function to do the completion itself.\n\
1423 PREDICATE limits completion to a subset of TABLE.\n\
1424 See `try-completion' and `all-completions' for more details\n\
1425 on completion, TABLE, and PREDICATE.\n\
1427 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1428 the input is (or completes to) an element of TABLE or is null.\n\
1429 If it is also not t, Return does not exit if it does non-null completion.\n\
1430 If the input is null, `completing-read' returns an empty string,\n\
1431 regardless of the value of REQUIRE-MATCH.\n\
1433 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1434 If it is (STRING . POSITION), the initial input\n\
1435 is STRING, but point is placed POSITION characters into the string.\n\
1436 HIST, if non-nil, specifies a history list\n\
1437 and optionally the initial position in the list.\n\
1438 It can be a symbol, which is the history list variable to use,\n\
1439 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1440 In that case, HISTVAR is the history list variable to use,\n\
1441 and HISTPOS is the initial position (the position in the list\n\
1442 which INITIAL-INPUT corresponds to).\n\
1443 Positions are counted starting from 1 at the beginning of the list.\n\
1444 DEF, if non-nil, is the default value.\n\
1446 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1447 the current input method and the setting of enable-multibyte-characters.\n\
1449 Completion ignores case if the ambient value of\n\
1450 `completion-ignore-case' is non-nil."
1452 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1453 0 /* See immediately above */)
1454 (prompt
, table
, predicate
, require_match
, initial_input
, hist
, def
, inherit_input_method
)
1455 Lisp_Object prompt
, table
, predicate
, require_match
, initial_input
;
1456 Lisp_Object hist
, def
, inherit_input_method
;
1458 Lisp_Object val
, histvar
, histpos
, position
;
1461 int count
= specpdl_ptr
- specpdl
;
1462 struct gcpro gcpro1
;
1464 init
= initial_input
;
1467 specbind (Qminibuffer_completion_table
, table
);
1468 specbind (Qminibuffer_completion_predicate
, predicate
);
1469 specbind (Qminibuffer_completion_confirm
,
1470 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1471 last_exact_completion
= Qnil
;
1478 position
= Fcdr (init
);
1481 CHECK_STRING (init
, 0);
1482 if (!NILP (position
))
1484 CHECK_NUMBER (position
, 0);
1485 /* Convert to distance from end of input. */
1486 pos
= XINT (position
) - XSTRING (init
)->size
;
1497 histvar
= Fcar_safe (hist
);
1498 histpos
= Fcdr_safe (hist
);
1501 histvar
= Qminibuffer_history
;
1503 XSETFASTINT (histpos
, 0);
1505 val
= read_minibuf (NILP (require_match
)
1506 ? Vminibuffer_local_completion_map
1507 : Vminibuffer_local_must_match_map
,
1508 init
, prompt
, make_number (pos
), 0,
1509 histvar
, histpos
, def
, 0,
1510 !NILP (inherit_input_method
));
1512 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1515 RETURN_UNGCPRO (unbind_to (count
, val
));
1518 Lisp_Object
Fminibuffer_completion_help ();
1519 Lisp_Object
assoc_for_completion ();
1521 /* Test whether TXT is an exact completion. */
1523 test_completion (txt
)
1528 if (CONSP (Vminibuffer_completion_table
)
1529 || NILP (Vminibuffer_completion_table
))
1530 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1531 else if (VECTORP (Vminibuffer_completion_table
))
1533 /* Bypass intern-soft as that loses for nil */
1534 tem
= oblookup (Vminibuffer_completion_table
,
1535 XSTRING (txt
)->data
,
1536 XSTRING (txt
)->size
,
1537 STRING_BYTES (XSTRING (txt
)));
1540 if (STRING_MULTIBYTE (txt
))
1541 txt
= Fstring_make_unibyte (txt
);
1543 txt
= Fstring_make_multibyte (txt
);
1545 tem
= oblookup (Vminibuffer_completion_table
,
1546 XSTRING (txt
)->data
,
1547 XSTRING (txt
)->size
,
1548 STRING_BYTES (XSTRING (txt
)));
1552 if (!NILP (Vminibuffer_completion_predicate
))
1553 return call1 (Vminibuffer_completion_predicate
, tem
);
1558 return call3 (Vminibuffer_completion_table
, txt
,
1559 Vminibuffer_completion_predicate
, Qlambda
);
1563 * 0 no possible completion
1564 * 1 was already an exact and unique completion
1565 * 3 was already an exact completion
1566 * 4 completed to an exact completion
1567 * 5 some completion happened
1568 * 6 no completion happened
1573 Lisp_Object completion
, tem
;
1576 struct gcpro gcpro1
, gcpro2
;
1578 completion
= Ftry_completion (Ffield_string (ZV
),
1579 Vminibuffer_completion_table
,
1580 Vminibuffer_completion_predicate
);
1581 last
= last_exact_completion
;
1582 last_exact_completion
= Qnil
;
1584 GCPRO2 (completion
, last
);
1586 if (NILP (completion
))
1589 temp_echo_area_glyphs (" [No match]");
1594 if (EQ (completion
, Qt
)) /* exact and unique match */
1601 tem
= Fstring_equal (completion
, Ffield_string(ZV
));
1602 completedp
= NILP (tem
);
1605 Fdelete_field (make_number (ZV
)); /* Some completion happened */
1606 Finsert (1, &completion
);
1609 /* It did find a match. Do we match some possibility exactly now? */
1610 tem
= test_completion (Ffield_string(ZV
));
1613 /* not an exact match */
1618 Fminibuffer_completion_help ();
1620 temp_echo_area_glyphs (" [Next char not unique]");
1623 else if (completedp
)
1628 /* If the last exact completion and this one were the same,
1629 it means we've already given a "Complete but not unique"
1630 message and the user's hit TAB again, so now we give him help. */
1631 last_exact_completion
= completion
;
1634 tem
= Ffield_string (ZV
);
1635 if (!NILP (Fequal (tem
, last
)))
1636 Fminibuffer_completion_help ();
1642 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1645 assoc_for_completion (key
, list
)
1646 register Lisp_Object key
;
1649 register Lisp_Object tail
;
1651 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1653 register Lisp_Object elt
, tem
, thiscar
;
1655 if (!CONSP (elt
)) continue;
1656 thiscar
= Fcar (elt
);
1657 if (!STRINGP (thiscar
))
1659 tem
= Fcompare_strings (thiscar
, make_number (0), Qnil
,
1660 key
, make_number (0), Qnil
,
1661 completion_ignore_case
? Qt
: Qnil
);
1669 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1670 "Complete the minibuffer contents as far as possible.\n\
1671 Return nil if there is no valid completion, else t.\n\
1672 If no characters can be completed, display a list of possible completions.\n\
1673 If you repeat this command after it displayed such a list,\n\
1674 scroll the window of possible completions.")
1678 Lisp_Object window
, tem
;
1680 /* If the previous command was not this,
1681 mark the completion buffer obsolete. */
1682 if (! EQ (current_kboard
->Vlast_command
, Vthis_command
))
1683 Vminibuf_scroll_window
= Qnil
;
1685 window
= Vminibuf_scroll_window
;
1686 /* If there's a fresh completion window with a live buffer,
1687 and this command is repeated, scroll that window. */
1688 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1689 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1691 struct buffer
*obuf
= current_buffer
;
1693 Fset_buffer (XWINDOW (window
)->buffer
);
1694 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1696 /* If end is in view, scroll up to the beginning. */
1697 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1699 /* Else scroll down one screen. */
1700 Fscroll_other_window (Qnil
);
1702 set_buffer_internal (obuf
);
1706 i
= do_completion ();
1713 temp_echo_area_glyphs (" [Sole completion]");
1717 temp_echo_area_glyphs (" [Complete, but not unique]");
1724 /* Subroutines of Fminibuffer_complete_and_exit. */
1726 /* This one is called by internal_condition_case to do the real work. */
1729 complete_and_exit_1 ()
1731 return make_number (do_completion ());
1734 /* This one is called by internal_condition_case if an error happens.
1735 Pretend the current value is an exact match. */
1738 complete_and_exit_2 (ignore
)
1741 return make_number (1);
1744 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1745 Sminibuffer_complete_and_exit
, 0, 0, "",
1746 "If the minibuffer contents is a valid completion then exit.\n\
1747 Otherwise try to complete it. If completion leads to a valid completion,\n\
1748 a repetition of this command will exit.")
1754 /* Allow user to specify null string */
1755 if (Ffield_beginning (ZV
, Qnil
) == ZV
)
1758 if (!NILP (test_completion (Ffield_string (ZV
))))
1761 /* Call do_completion, but ignore errors. */
1762 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1763 complete_and_exit_2
);
1773 if (!NILP (Vminibuffer_completion_confirm
))
1775 temp_echo_area_glyphs (" [Confirm]");
1785 Fthrow (Qexit
, Qnil
);
1789 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1791 "Complete the minibuffer contents at most a single word.\n\
1792 After one word is completed as much as possible, a space or hyphen\n\
1793 is added, provided that matches some possible completion.\n\
1794 Return nil if there is no valid completion, else t.")
1797 Lisp_Object completion
, tem
, tem1
;
1798 register int i
, i_byte
;
1799 register unsigned char *completion_string
;
1800 struct gcpro gcpro1
, gcpro2
;
1801 int prompt_end_charpos
;
1803 /* We keep calling Fbuffer_string rather than arrange for GC to
1804 hold onto a pointer to one of the strings thus made. */
1806 completion
= Ftry_completion (Ffield_string (ZV
),
1807 Vminibuffer_completion_table
,
1808 Vminibuffer_completion_predicate
);
1809 if (NILP (completion
))
1812 temp_echo_area_glyphs (" [No match]");
1815 if (EQ (completion
, Qt
))
1818 #if 0 /* How the below code used to look, for reference. */
1819 tem
= Ffield_string (ZV
);
1820 b
= XSTRING (tem
)->data
;
1821 i
= ZV
- 1 - XSTRING (completion
)->size
;
1822 p
= XSTRING (completion
)->data
;
1824 0 <= scmp (b
, p
, ZV
- 1))
1827 /* Set buffer to longest match of buffer tail and completion head. */
1828 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1830 del_range (1, i
+ 1);
1833 #else /* Rewritten code */
1835 int buffer_nchars
, completion_nchars
;
1837 CHECK_STRING (completion
, 0);
1838 tem
= Ffield_string (ZV
);
1839 GCPRO2 (completion
, tem
);
1840 /* If reading a file name,
1841 expand any $ENVVAR refs in the buffer and in TEM. */
1842 if (! NILP (Vminibuffer_completing_file_name
))
1844 Lisp_Object substituted
;
1845 substituted
= Fsubstitute_in_file_name (tem
);
1846 if (! EQ (substituted
, tem
))
1849 Fdelete_field (make_number (ZV
));
1850 insert_from_string (tem
, 0, 0, XSTRING (tem
)->size
,
1851 STRING_BYTES (XSTRING (tem
)), 0);
1854 buffer_nchars
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1855 completion_nchars
= XSTRING (completion
)->size
;
1856 i
= buffer_nchars
- completion_nchars
;
1859 (tem1
= Fcompare_strings (tem
, make_number (0),
1860 make_number (buffer_nchars
),
1861 completion
, make_number (0),
1862 make_number (buffer_nchars
),
1863 completion_ignore_case
? Qt
: Qnil
),
1868 /* Set buffer to longest match of buffer tail and completion head. */
1874 tem1
= Fcompare_strings (tem
, make_number (start_pos
), Qnil
,
1875 completion
, make_number (0),
1876 make_number (buffer_nchars
),
1877 completion_ignore_case
? Qt
: Qnil
);
1884 del_range (1, i
+ 1);
1885 SET_PT_BOTH (ZV
, ZV_BYTE
);
1889 #endif /* Rewritten code */
1891 prompt_end_charpos
= Ffield_beginning (make_number (ZV
), Qnil
);
1894 int prompt_end_bytepos
;
1895 prompt_end_bytepos
= CHAR_TO_BYTE (prompt_end_charpos
);
1896 i
= ZV
- prompt_end_charpos
;
1897 i_byte
= ZV_BYTE
- prompt_end_bytepos
;
1900 /* If completion finds next char not unique,
1901 consider adding a space or a hyphen. */
1902 if (i
== XSTRING (completion
)->size
)
1904 GCPRO1 (completion
);
1905 tem
= Ftry_completion (concat2 (Ffield_string (ZV
), build_string (" ")),
1906 Vminibuffer_completion_table
,
1907 Vminibuffer_completion_predicate
);
1914 GCPRO1 (completion
);
1916 Ftry_completion (concat2 (Ffield_string (ZV
), build_string ("-")),
1917 Vminibuffer_completion_table
,
1918 Vminibuffer_completion_predicate
);
1926 /* Now find first word-break in the stuff found by completion.
1927 i gets index in string of where to stop completing. */
1930 int bytes
= STRING_BYTES (XSTRING (completion
));
1931 completion_string
= XSTRING (completion
)->data
;
1932 for (; i_byte
< STRING_BYTES (XSTRING (completion
)); i_byte
+= len
, i
++)
1934 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i_byte
,
1937 if (SYNTAX (c
) != Sword
)
1946 /* If got no characters, print help for user. */
1948 if (i
== ZV
- prompt_end_charpos
)
1951 Fminibuffer_completion_help ();
1955 /* Otherwise insert in minibuffer the chars we got */
1957 Fdelete_field (make_number (ZV
));
1958 insert_from_string (completion
, 0, 0, i
, i_byte
, 1);
1962 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1964 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1965 Each element may be just a symbol or string\n\
1966 or may be a list of two strings to be printed as if concatenated.\n\
1967 `standard-output' must be a buffer.\n\
1968 The actual completion alternatives, as inserted, are given `mouse-face'\n\
1969 properties of `highlight'.\n\
1970 At the end, this runs the normal hook `completion-setup-hook'.\n\
1971 It can find the completion buffer in `standard-output'.")
1973 Lisp_Object completions
;
1975 Lisp_Object tail
, elt
;
1978 struct gcpro gcpro1
, gcpro2
;
1979 struct buffer
*old
= current_buffer
;
1982 /* Note that (when it matters) every variable
1983 points to a non-string that is pointed to by COMPLETIONS,
1984 except for ELT. ELT can be pointing to a string
1985 when terpri or Findent_to calls a change hook. */
1987 GCPRO2 (completions
, elt
);
1989 if (BUFFERP (Vstandard_output
))
1990 set_buffer_internal (XBUFFER (Vstandard_output
));
1992 if (NILP (completions
))
1993 write_string ("There are no possible completions of what you have typed.",
1997 write_string ("Possible completions are:", -1);
1998 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
2000 Lisp_Object tem
, string
;
2002 Lisp_Object startpos
, endpos
;
2005 /* Compute the length of this element. */
2009 CHECK_STRING (tem
, 0);
2010 length
= XSTRING (tem
)->size
;
2012 tem
= Fcar (XCDR (elt
));
2013 CHECK_STRING (tem
, 0);
2014 length
+= XSTRING (tem
)->size
;
2018 CHECK_STRING (elt
, 0);
2019 length
= XSTRING (elt
)->size
;
2022 /* This does a bad job for narrower than usual windows.
2023 Sadly, the window it will appear in is not known
2024 until after the text has been made. */
2026 if (BUFFERP (Vstandard_output
))
2027 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2029 /* If the previous completion was very wide,
2030 or we have two on this line already,
2031 don't put another on the same line. */
2032 if (column
> 33 || first
2033 /* If this is really wide, don't put it second on a line. */
2034 || (column
> 0 && length
> 45))
2039 /* Otherwise advance to column 35. */
2042 if (BUFFERP (Vstandard_output
))
2044 tem
= Findent_to (make_number (35), make_number (2));
2046 column
= XINT (tem
);
2052 write_string (" ", -1);
2055 while (column
< 35);
2059 if (BUFFERP (Vstandard_output
))
2061 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2062 Fset_text_properties (startpos
, endpos
,
2063 Qnil
, Vstandard_output
);
2066 /* Output this element.
2067 If necessary, convert it to unibyte or to multibyte first. */
2069 string
= Fcar (elt
);
2072 if (NILP (current_buffer
->enable_multibyte_characters
)
2073 && STRING_MULTIBYTE (string
))
2074 string
= Fstring_make_unibyte (string
);
2075 else if (!NILP (current_buffer
->enable_multibyte_characters
)
2076 && !STRING_MULTIBYTE (string
))
2077 string
= Fstring_make_multibyte (string
);
2079 if (BUFFERP (Vstandard_output
))
2081 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2083 Fprinc (string
, Qnil
);
2085 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2087 Fput_text_property (startpos
, endpos
,
2088 Qmouse_face
, intern ("highlight"),
2093 Fprinc (string
, Qnil
);
2096 /* Output the annotation for this element. */
2099 if (BUFFERP (Vstandard_output
))
2101 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2103 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2105 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2107 Fset_text_properties (startpos
, endpos
, Qnil
,
2112 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2117 /* Update COLUMN for what we have output. */
2120 /* If output is to a buffer, recompute COLUMN in a way
2121 that takes account of character widths. */
2122 if (BUFFERP (Vstandard_output
))
2124 tem
= Fcurrent_column ();
2125 column
= XINT (tem
);
2134 if (BUFFERP (Vstandard_output
))
2135 set_buffer_internal (old
);
2137 if (!NILP (Vrun_hooks
))
2138 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
2143 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
2145 "Display a list of possible completions of the current minibuffer contents.")
2148 Lisp_Object completions
;
2150 message ("Making completion list...");
2151 completions
= Fall_completions (Ffield_string (ZV
),
2152 Vminibuffer_completion_table
,
2153 Vminibuffer_completion_predicate
,
2155 clear_message (1, 0);
2157 if (NILP (completions
))
2160 temp_echo_area_glyphs (" [No completions]");
2163 internal_with_output_to_temp_buffer ("*Completions*",
2164 Fdisplay_completion_list
,
2165 Fsort (completions
, Qstring_lessp
));
2169 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
2170 "Terminate minibuffer input.")
2173 if (INTEGERP (last_command_char
))
2174 internal_self_insert (XINT (last_command_char
), 0);
2178 Fthrow (Qexit
, Qnil
);
2181 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
2182 "Terminate this minibuffer argument.")
2185 Fthrow (Qexit
, Qnil
);
2188 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
2189 "Return current depth of activations of minibuffer, a nonnegative integer.")
2192 return make_number (minibuf_level
);
2195 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
2196 "Return the prompt string of the currently-active minibuffer.\n\
2197 If no minibuffer is active, return nil.")
2200 return Fcopy_sequence (minibuf_prompt
);
2204 /* Temporarily display the string M at the end of the current
2205 minibuffer contents. This is used to display things like
2206 "[No Match]" when the user requests a completion for a prefix
2207 that has no possible completions, and other quick, unobtrusive
2211 temp_echo_area_glyphs (m
)
2215 int osize_byte
= ZV_BYTE
;
2217 int opoint_byte
= PT_BYTE
;
2218 Lisp_Object oinhibit
;
2219 oinhibit
= Vinhibit_quit
;
2221 /* Clear out any old echo-area message to make way for our new thing. */
2224 SET_PT_BOTH (osize
, osize_byte
);
2226 SET_PT_BOTH (opoint
, opoint_byte
);
2228 Fsit_for (make_number (2), Qnil
, Qnil
);
2229 del_range_both (osize
, osize_byte
, ZV
, ZV_BYTE
, 1);
2230 SET_PT_BOTH (opoint
, opoint_byte
);
2231 if (!NILP (Vquit_flag
))
2234 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
2236 Vinhibit_quit
= oinhibit
;
2239 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
2241 "Temporarily display STRING at the end of the minibuffer.\n\
2242 The text is displayed for two seconds,\n\
2243 or until the next input event arrives, whichever comes first.")
2247 temp_echo_area_glyphs (XSTRING (string
)->data
);
2252 init_minibuf_once ()
2254 Vminibuffer_list
= Qnil
;
2255 staticpro (&Vminibuffer_list
);
2262 minibuf_prompt
= Qnil
;
2263 staticpro (&minibuf_prompt
);
2265 minibuf_save_list
= Qnil
;
2266 staticpro (&minibuf_save_list
);
2268 Qread_file_name_internal
= intern ("read-file-name-internal");
2269 staticpro (&Qread_file_name_internal
);
2271 Qminibuffer_default
= intern ("minibuffer-default");
2272 staticpro (&Qminibuffer_default
);
2273 Fset (Qminibuffer_default
, Qnil
);
2275 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
2276 staticpro (&Qminibuffer_completion_table
);
2278 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
2279 staticpro (&Qminibuffer_completion_confirm
);
2281 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
2282 staticpro (&Qminibuffer_completion_predicate
);
2284 staticpro (&last_exact_completion
);
2285 last_exact_completion
= Qnil
;
2287 staticpro (&last_minibuf_string
);
2288 last_minibuf_string
= Qnil
;
2290 Quser_variable_p
= intern ("user-variable-p");
2291 staticpro (&Quser_variable_p
);
2293 Qminibuffer_history
= intern ("minibuffer-history");
2294 staticpro (&Qminibuffer_history
);
2296 Qbuffer_name_history
= intern ("buffer-name-history");
2297 staticpro (&Qbuffer_name_history
);
2298 Fset (Qbuffer_name_history
, Qnil
);
2300 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2301 staticpro (&Qminibuffer_setup_hook
);
2303 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2304 staticpro (&Qminibuffer_exit_hook
);
2306 Qhistory_length
= intern ("history-length");
2307 staticpro (&Qhistory_length
);
2309 Qcurrent_input_method
= intern ("current-input-method");
2310 staticpro (&Qcurrent_input_method
);
2312 Qactivate_input_method
= intern ("activate-input-method");
2313 staticpro (&Qactivate_input_method
);
2315 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2316 "If this is non-nil, `read-buffer' does its work by calling this function.");
2317 Vread_buffer_function
= Qnil
;
2319 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2320 "Normal hook run just after entry to minibuffer.");
2321 Vminibuffer_setup_hook
= Qnil
;
2323 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2324 "Normal hook run just after exit from minibuffer.");
2325 Vminibuffer_exit_hook
= Qnil
;
2327 DEFVAR_LISP ("history-length", &Vhistory_length
,
2328 "*Maximum length for history lists before truncation takes place.\n\
2329 A number means that length; t means infinite. Truncation takes place\n\
2330 just after a new element is inserted. Setting the history-length\n\
2331 property of a history variable overrides this default.");
2332 XSETFASTINT (Vhistory_length
, 30);
2334 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
2335 "*Non-nil means automatically provide help for invalid completion input.");
2338 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2339 "Non-nil means don't consider case significant in completion.");
2340 completion_ignore_case
= 0;
2342 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2343 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2344 This variable makes a difference whenever the minibuffer window is active.");
2345 enable_recursive_minibuffers
= 0;
2347 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2348 "Alist or obarray used for completion in the minibuffer.\n\
2349 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2351 The value may alternatively be a function, which is given three arguments:\n\
2352 STRING, the current buffer contents;\n\
2353 PREDICATE, the predicate for filtering possible matches;\n\
2354 CODE, which says what kind of things to do.\n\
2355 CODE can be nil, t or `lambda'.\n\
2356 nil means to return the best completion of STRING, or nil if there is none.\n\
2357 t means to return a list of all possible completions of STRING.\n\
2358 `lambda' means to return t if STRING is a valid completion as it stands.");
2359 Vminibuffer_completion_table
= Qnil
;
2361 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2362 "Within call to `completing-read', this holds the PREDICATE argument.");
2363 Vminibuffer_completion_predicate
= Qnil
;
2365 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2366 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2367 Vminibuffer_completion_confirm
= Qnil
;
2369 DEFVAR_LISP ("minibuffer-completing-file-name",
2370 &Vminibuffer_completing_file_name
,
2371 "Non-nil means completing file names.");
2372 Vminibuffer_completing_file_name
= Qnil
;
2374 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2375 "Value that `help-form' takes on inside the minibuffer.");
2376 Vminibuffer_help_form
= Qnil
;
2378 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2379 "History list symbol to add minibuffer values to.\n\
2380 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2382 (set minibuffer-history-variable\n\
2383 (cons STRING (symbol-value minibuffer-history-variable)))");
2384 XSETFASTINT (Vminibuffer_history_variable
, 0);
2386 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2387 "Current position of redoing in the history list.");
2388 Vminibuffer_history_position
= Qnil
;
2390 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2391 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2392 Some uses of the echo area also raise that frame (since they use it too).");
2393 minibuffer_auto_raise
= 0;
2395 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2396 "List of regexps that should restrict possible completions.");
2397 Vcompletion_regexp_list
= Qnil
;
2399 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2400 &minibuffer_allow_text_properties
,
2401 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2402 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2403 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2404 with completion; they always discard text properties.");
2405 minibuffer_allow_text_properties
= 0;
2407 defsubr (&Sset_minibuffer_window
);
2408 defsubr (&Sread_from_minibuffer
);
2409 defsubr (&Seval_minibuffer
);
2410 defsubr (&Sread_minibuffer
);
2411 defsubr (&Sread_string
);
2412 defsubr (&Sread_command
);
2413 defsubr (&Sread_variable
);
2414 defsubr (&Sread_buffer
);
2415 defsubr (&Sread_no_blanks_input
);
2416 defsubr (&Sminibuffer_depth
);
2417 defsubr (&Sminibuffer_prompt
);
2419 defsubr (&Stry_completion
);
2420 defsubr (&Sall_completions
);
2421 defsubr (&Scompleting_read
);
2422 defsubr (&Sminibuffer_complete
);
2423 defsubr (&Sminibuffer_complete_word
);
2424 defsubr (&Sminibuffer_complete_and_exit
);
2425 defsubr (&Sdisplay_completion_list
);
2426 defsubr (&Sminibuffer_completion_help
);
2428 defsubr (&Sself_insert_and_exit
);
2429 defsubr (&Sexit_minibuffer
);
2431 defsubr (&Sminibuffer_message
);
2437 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2438 "abort-recursive-edit");
2439 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2441 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2444 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2445 "abort-recursive-edit");
2446 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2448 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2451 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2453 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2455 initial_define_key (Vminibuffer_local_ns_map
, '?',
2456 "self-insert-and-exit");
2458 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2459 "abort-recursive-edit");
2460 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2462 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2465 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2466 "minibuffer-complete");
2467 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2468 "minibuffer-complete-word");
2469 initial_define_key (Vminibuffer_local_completion_map
, '?',
2470 "minibuffer-completion-help");
2472 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2473 "abort-recursive-edit");
2474 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2475 "minibuffer-complete-and-exit");
2476 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2477 "minibuffer-complete-and-exit");
2478 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2479 "minibuffer-complete");
2480 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2481 "minibuffer-complete-word");
2482 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2483 "minibuffer-completion-help");