1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000
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 ();
362 #ifdef HAVE_X_WINDOWS
363 if (display_busy_cursor_p
)
364 cancel_busy_cursor ();
368 ambient_dir
= current_buffer
->directory
;
370 enable_multibyte
= Qnil
;
372 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
373 store them away before we can GC. Don't need to protect
374 BACKUP_N because we use the value only if it is an integer. */
375 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
377 if (!STRINGP (prompt
))
378 prompt
= build_string ("");
380 if (!enable_recursive_minibuffers
381 && minibuf_level
> 0)
383 if (EQ (selected_window
, minibuf_window
))
384 error ("Command attempted to use minibuffer while in minibuffer");
386 /* If we're in another window, cancel the minibuffer that's active. */
388 build_string ("Command attempted to use minibuffer while in minibuffer"));
392 return read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
,
393 expflag
, histvar
, histpos
, defalt
,
394 allow_props
, inherit_input_method
);
396 /* Choose the minibuffer window and frame, and take action on them. */
398 choose_minibuf_frame ();
400 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
402 record_unwind_protect (Fset_window_configuration
,
403 Fcurrent_window_configuration (Qnil
));
405 /* If the minibuffer window is on a different frame, save that
406 frame's configuration too. */
407 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
408 if (!EQ (mini_frame
, selected_frame
))
409 record_unwind_protect (Fset_window_configuration
,
410 Fcurrent_window_configuration (mini_frame
));
412 /* If the minibuffer is on an iconified or invisible frame,
413 make it visible now. */
414 Fmake_frame_visible (mini_frame
);
416 if (minibuffer_auto_raise
)
417 Fraise_frame (mini_frame
);
419 /* We have to do this after saving the window configuration
420 since that is what restores the current buffer. */
422 /* Arrange to restore a number of minibuffer-related variables.
423 We could bind each variable separately, but that would use lots of
426 = Fcons (Voverriding_local_map
,
427 Fcons (minibuf_window
, minibuf_save_list
));
429 = Fcons (minibuf_prompt
,
430 Fcons (make_number (minibuf_prompt_width
),
432 Fcons (Vcurrent_prefix_arg
,
433 Fcons (Vminibuffer_history_position
,
434 Fcons (Vminibuffer_history_variable
,
435 minibuf_save_list
))))));
437 record_unwind_protect (read_minibuf_unwind
, Qnil
);
440 /* Now that we can restore all those variables, start changing them. */
442 minibuf_prompt_width
= 0;
443 minibuf_prompt
= Fcopy_sequence (prompt
);
444 Vminibuffer_history_position
= histpos
;
445 Vminibuffer_history_variable
= histvar
;
446 Vhelp_form
= Vminibuffer_help_form
;
448 if (inherit_input_method
)
450 /* `current-input-method' is buffer local. So, remeber it in
451 INPUT_METHOD before changing the current buffer. */
452 input_method
= Fsymbol_value (Qcurrent_input_method
);
453 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
456 /* Switch to the minibuffer. */
458 minibuffer
= get_minibuffer (minibuf_level
);
459 Fset_buffer (minibuffer
);
461 /* The current buffer's default directory is usually the right thing
462 for our minibuffer here. However, if you're typing a command at
463 a minibuffer-only frame when minibuf_level is zero, then buf IS
464 the current_buffer, so reset_buffer leaves buf's default
465 directory unchanged. This is a bummer when you've just started
466 up Emacs and buf's default directory is Qnil. Here's a hack; can
467 you think of something better to do? Find another buffer with a
468 better directory, and use that one instead. */
469 if (STRINGP (ambient_dir
))
470 current_buffer
->directory
= ambient_dir
;
473 Lisp_Object buf_list
;
475 for (buf_list
= Vbuffer_alist
;
477 buf_list
= XCDR (buf_list
))
479 Lisp_Object other_buf
;
481 other_buf
= XCDR (XCAR (buf_list
));
482 if (STRINGP (XBUFFER (other_buf
)->directory
))
484 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
490 if (!EQ (mini_frame
, selected_frame
))
491 Fredirect_frame_focus (selected_frame
, mini_frame
);
493 Vminibuf_scroll_window
= selected_window
;
494 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
495 Fselect_window (minibuf_window
);
496 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
498 Fmake_local_variable (Qprint_escape_newlines
);
499 print_escape_newlines
= 1;
501 /* Erase the buffer. */
503 int count1
= specpdl_ptr
- specpdl
;
504 specbind (Qinhibit_read_only
, Qt
);
506 unbind_to (count1
, Qnil
);
509 if (!NILP (current_buffer
->enable_multibyte_characters
)
510 && ! STRING_MULTIBYTE (minibuf_prompt
))
511 minibuf_prompt
= Fstring_make_multibyte (minibuf_prompt
);
513 /* Insert the prompt, record where it ends. */
514 Finsert (1, &minibuf_prompt
);
517 Fput_text_property (make_number (BEG
), make_number (PT
),
518 Qfront_sticky
, Qt
, Qnil
);
519 Fput_text_property (make_number (BEG
), make_number (PT
),
520 Qrear_nonsticky
, Qt
, Qnil
);
521 Fput_text_property (make_number (BEG
), make_number (PT
),
523 Fput_text_property (make_number (BEG
), make_number (PT
),
524 Qread_only
, Qt
, Qnil
);
527 minibuf_prompt_width
= current_column ();
529 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
530 if (inherit_input_method
)
531 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
533 /* Put in the initial input. */
536 Finsert (1, &initial
);
537 if (INTEGERP (backup_n
))
538 Fforward_char (backup_n
);
541 clear_message (1, 1);
542 current_buffer
->keymap
= map
;
544 /* Turn on an input method stored in INPUT_METHOD if any. */
545 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
546 call1 (Qactivate_input_method
, input_method
);
548 /* Run our hook, but not if it is empty.
549 (run-hooks would do nothing if it is empty,
550 but it's important to save time here in the usual case). */
551 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
552 && !NILP (Vrun_hooks
))
553 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
557 /* If cursor is on the minibuffer line,
558 show the user we have exited by putting it in column 0. */
559 if (XWINDOW (minibuf_window
)->cursor
.vpos
>= 0
562 XWINDOW (minibuf_window
)->cursor
.hpos
= 0;
563 XWINDOW (minibuf_window
)->cursor
.x
= 0;
564 XWINDOW (minibuf_window
)->must_be_updated_p
= 1;
565 update_frame (XFRAME (selected_frame
), 1, 1);
566 if (rif
&& rif
->flush_display
)
567 rif
->flush_display (XFRAME (XWINDOW (minibuf_window
)->frame
));
570 /* Make minibuffer contents into a string. */
571 Fset_buffer (minibuffer
);
573 val
= Ffield_string (make_number (ZV
));
575 val
= Ffield_string_no_properties (make_number (ZV
));
577 /* VAL is the string of minibuffer text. */
579 last_minibuf_string
= val
;
581 /* Add the value to the appropriate history list unless it is empty. */
582 if (XSTRING (val
)->size
!= 0
583 && SYMBOLP (Vminibuffer_history_variable
))
585 /* If the caller wanted to save the value read on a history list,
586 then do so if the value is not already the front of the list. */
589 /* If variable is unbound, make it nil. */
590 if (EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
591 Fset (Vminibuffer_history_variable
, Qnil
);
593 histval
= Fsymbol_value (Vminibuffer_history_variable
);
595 /* The value of the history variable must be a cons or nil. Other
596 values are unacceptable. We silently ignore these values. */
599 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
603 histval
= Fcons (last_minibuf_string
, histval
);
604 Fset (Vminibuffer_history_variable
, histval
);
606 /* Truncate if requested. */
607 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
608 if (NILP (length
)) length
= Vhistory_length
;
609 if (INTEGERP (length
))
611 if (XINT (length
) <= 0)
612 Fset (Vminibuffer_history_variable
, Qnil
);
617 temp
= Fnthcdr (Fsub1 (length
), histval
);
618 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
624 /* If Lisp form desired instead of string, parse it. */
626 val
= string_to_object (val
, defalt
);
628 /* The appropriate frame will get selected
629 in set-window-configuration. */
630 RETURN_UNGCPRO (unbind_to (count
, val
));
633 /* Return a buffer to be used as the minibuffer at depth `depth'.
634 depth = 0 is the lowest allowed argument, and that is the value
635 used for nonrecursive minibuffer invocations */
638 get_minibuffer (depth
)
641 Lisp_Object tail
, num
, buf
;
643 extern Lisp_Object
nconc2 ();
645 XSETFASTINT (num
, depth
);
646 tail
= Fnthcdr (num
, Vminibuffer_list
);
649 tail
= Fcons (Qnil
, Qnil
);
650 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
653 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
655 sprintf (name
, " *Minibuf-%d*", depth
);
656 buf
= Fget_buffer_create (build_string (name
));
658 /* Although the buffer's name starts with a space, undo should be
660 Fbuffer_enable_undo (buf
);
666 int count
= specpdl_ptr
- specpdl
;
668 reset_buffer (XBUFFER (buf
));
669 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
671 Fkill_all_local_variables ();
672 unbind_to (count
, Qnil
);
678 /* This function is called on exiting minibuffer, whether normally or
679 not, and it restores the current window, buffer, etc. */
682 read_minibuf_unwind (data
)
685 Lisp_Object old_deactivate_mark
;
688 /* We are exiting the minibuffer one way or the other,
690 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
691 && !NILP (Vrun_hooks
))
692 safe_run_hooks (Qminibuffer_exit_hook
);
694 /* If this was a recursive minibuffer,
695 tie the minibuffer window back to the outer level minibuffer buffer. */
698 window
= minibuf_window
;
699 /* To keep things predictable, in case it matters, let's be in the
700 minibuffer when we reset the relevant variables. */
701 Fset_buffer (XWINDOW (window
)->buffer
);
703 /* Restore prompt, etc, from outer minibuffer level. */
704 minibuf_prompt
= Fcar (minibuf_save_list
);
705 minibuf_save_list
= Fcdr (minibuf_save_list
);
706 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
707 minibuf_save_list
= Fcdr (minibuf_save_list
);
708 Vhelp_form
= Fcar (minibuf_save_list
);
709 minibuf_save_list
= Fcdr (minibuf_save_list
);
710 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
711 minibuf_save_list
= Fcdr (minibuf_save_list
);
712 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
713 minibuf_save_list
= Fcdr (minibuf_save_list
);
714 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
715 minibuf_save_list
= Fcdr (minibuf_save_list
);
716 Voverriding_local_map
= Fcar (minibuf_save_list
);
717 minibuf_save_list
= Fcdr (minibuf_save_list
);
719 temp
= Fcar (minibuf_save_list
);
720 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
721 minibuf_window
= temp
;
723 minibuf_save_list
= Fcdr (minibuf_save_list
);
725 /* Erase the minibuffer we were using at this level. */
727 int count
= specpdl_ptr
- specpdl
;
728 /* Prevent error in erase-buffer. */
729 specbind (Qinhibit_read_only
, Qt
);
730 old_deactivate_mark
= Vdeactivate_mark
;
732 Vdeactivate_mark
= old_deactivate_mark
;
733 unbind_to (count
, Qnil
);
736 /* When we get to the outmost level, make sure we resize the
737 mini-window back to its normal size. */
738 if (minibuf_level
== 0)
739 resize_mini_window (XWINDOW (window
), 0);
741 /* Make sure minibuffer window is erased, not ignored. */
742 windows_or_buffers_changed
++;
743 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
744 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
749 /* This comment supplies the doc string for read-from-minibuffer,
750 for make-docfile to see. We cannot put this in the real DEFUN
751 due to limits in the Unix cpp.
753 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
754 "Read a string from the minibuffer, prompting with string PROMPT.\n\
755 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
756 to be inserted into the minibuffer before reading input.\n\
757 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
758 is STRING, but point is placed at position POSITION in the minibuffer.\n\
759 Third arg KEYMAP is a keymap to use whilst reading;\n\
760 if omitted or nil, the default is `minibuffer-local-map'.\n\
761 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
762 and return that object:\n\
763 in other words, do `(car (read-from-string INPUT-STRING))'\n\
764 Fifth arg HIST, if non-nil, specifies a history list\n\
765 and optionally the initial position in the list.\n\
766 It can be a symbol, which is the history list variable to use,\n\
767 or it can be a cons cell (HISTVAR . HISTPOS).\n\
768 In that case, HISTVAR is the history list variable to use,\n\
769 and HISTPOS is the initial position (the position in the list\n\
770 which INITIAL-CONTENTS corresponds to).\n\
771 Positions are counted starting from 1 at the beginning of the list.\n\
772 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
773 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
774 if the user enters empty input! It returns the empty string.\n\
775 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
776 the current input method and the setting of enable-multibyte-characters.\n\
777 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
778 then the string which is returned includes whatever text properties\n\
779 were present in the minibuffer. Otherwise the value has no text properties.")
780 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
783 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
784 0 /* See immediately above */)
785 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
786 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
787 Lisp_Object inherit_input_method
;
790 Lisp_Object histvar
, histpos
, position
, val
;
795 CHECK_STRING (prompt
, 0);
796 if (!NILP (initial_contents
))
798 if (CONSP (initial_contents
))
800 position
= Fcdr (initial_contents
);
801 initial_contents
= Fcar (initial_contents
);
803 CHECK_STRING (initial_contents
, 1);
804 if (!NILP (position
))
806 CHECK_NUMBER (position
, 0);
807 /* Convert to distance from end of input. */
808 if (XINT (position
) < 1)
809 /* A number too small means the beginning of the string. */
810 pos
= - XSTRING (initial_contents
)->size
;
812 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
817 keymap
= Vminibuffer_local_map
;
819 keymap
= get_keymap (keymap
);
828 histvar
= Fcar_safe (hist
);
829 histpos
= Fcdr_safe (hist
);
832 histvar
= Qminibuffer_history
;
834 XSETFASTINT (histpos
, 0);
836 GCPRO1 (default_value
);
837 val
= read_minibuf (keymap
, initial_contents
, prompt
,
838 make_number (pos
), !NILP (read
),
839 histvar
, histpos
, default_value
,
840 minibuffer_allow_text_properties
,
841 !NILP (inherit_input_method
));
846 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
847 "Return a Lisp object read using the minibuffer.\n\
848 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
849 is a string to insert in the minibuffer before reading.")
850 (prompt
, initial_contents
)
851 Lisp_Object prompt
, initial_contents
;
853 CHECK_STRING (prompt
, 0);
854 if (!NILP (initial_contents
))
855 CHECK_STRING (initial_contents
, 1);
856 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
857 prompt
, Qnil
, 1, Qminibuffer_history
,
858 make_number (0), Qnil
, 0, 0);
861 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
862 "Return value of Lisp expression 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 return Feval (Fread_minibuffer (prompt
, initial_contents
));
871 /* Functions that use the minibuffer to read various things. */
873 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
874 "Read a string from the minibuffer, prompting with string PROMPT.\n\
875 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
876 The third arg HISTORY, if non-nil, specifies a history list\n\
877 and optionally the initial position in the list.\n\
878 See `read-from-minibuffer' for details of HISTORY argument.\n\
879 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
880 for history commands, and as the value to return if the user enters\n\
882 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
883 the current input method and the setting of enable-multibyte-characters.")
884 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
885 Lisp_Object prompt
, initial_input
, history
, default_value
;
886 Lisp_Object inherit_input_method
;
889 val
= Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
890 Qnil
, history
, default_value
,
891 inherit_input_method
);
892 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
897 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
898 "Read a string from the terminal, not allowing blanks.\n\
899 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
900 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
901 the current input method and the setting of enable-multibyte-characters.")
902 (prompt
, initial
, inherit_input_method
)
903 Lisp_Object prompt
, initial
, inherit_input_method
;
905 CHECK_STRING (prompt
, 0);
906 if (! NILP (initial
))
907 CHECK_STRING (initial
, 1);
909 return read_minibuf (Vminibuffer_local_ns_map
, initial
, prompt
, Qnil
,
910 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
911 !NILP (inherit_input_method
));
914 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
915 "Read the name of a command and return as a symbol.\n\
916 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
917 (prompt
, default_value
)
918 Lisp_Object prompt
, default_value
;
920 Lisp_Object name
, default_string
;
922 if (NILP (default_value
))
923 default_string
= Qnil
;
924 else if (SYMBOLP (default_value
))
925 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
927 default_string
= default_value
;
929 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
930 Qnil
, Qnil
, default_string
, Qnil
);
933 return Fintern (name
, Qnil
);
937 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
938 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
939 Prompts with PROMPT.")
943 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
948 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
949 "Read the name of a user variable and return it as a symbol.\n\
950 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
951 A user variable is one whose documentation starts with a `*' character.")
952 (prompt
, default_value
)
953 Lisp_Object prompt
, default_value
;
955 Lisp_Object name
, default_string
;
957 if (NILP (default_value
))
958 default_string
= Qnil
;
959 else if (SYMBOLP (default_value
))
960 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
962 default_string
= default_value
;
964 name
= Fcompleting_read (prompt
, Vobarray
,
965 Quser_variable_p
, Qt
,
966 Qnil
, Qnil
, default_string
, Qnil
);
969 return Fintern (name
, Qnil
);
972 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
973 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
974 Prompts with PROMPT.\n\
975 Optional second arg DEF is value to return if user enters an empty line.\n\
976 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
977 (prompt
, def
, require_match
)
978 Lisp_Object prompt
, def
, require_match
;
983 def
= XBUFFER (def
)->name
;
985 if (NILP (Vread_buffer_function
))
989 args
[0] = build_string ("%s(default %s) ");
992 prompt
= Fformat (3, args
);
995 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
996 require_match
, Qnil
, Qbuffer_name_history
,
1001 args
[0] = Vread_buffer_function
;
1004 args
[3] = require_match
;
1005 return Ffuncall(4, args
);
1010 minibuf_conform_representation (string
, basis
)
1011 Lisp_Object string
, basis
;
1013 if (STRING_MULTIBYTE (string
) == STRING_MULTIBYTE (basis
))
1016 if (STRING_MULTIBYTE (string
))
1017 return Fstring_make_unibyte (string
);
1019 return Fstring_make_multibyte (string
);
1022 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
1023 "Return common substring of all completions of STRING in ALIST.\n\
1024 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1025 All that match are compared together; the longest initial sequence\n\
1026 common to all matches is returned as a string.\n\
1027 If there is no match at all, nil is returned.\n\
1028 For a unique match which is exact, t is returned.\n\
1030 ALIST can be an obarray instead of an alist.\n\
1031 Then the print names of all symbols in the obarray are the possible matches.\n\
1033 ALIST can also be a function to do the completion itself.\n\
1034 It receives three arguments: the values STRING, PREDICATE and nil.\n\
1035 Whatever it returns becomes the value of `try-completion'.\n\
1037 If optional third argument PREDICATE is non-nil,\n\
1038 it is used to test each possible match.\n\
1039 The match is a candidate only if PREDICATE returns non-nil.\n\
1040 The argument given to PREDICATE is the alist element\n\
1041 or the symbol from the obarray.\n\
1042 Additionally to this predicate, `completion-regexp-list'\n\
1043 is used to further constrain the set of candidates.")
1044 (string
, alist
, predicate
)
1045 Lisp_Object string
, alist
, predicate
;
1047 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
1048 /* Size in bytes of BESTMATCH. */
1050 /* These are in bytes, too. */
1051 int compare
, matchsize
;
1052 int list
= CONSP (alist
) || NILP (alist
);
1055 Lisp_Object bucket
, zero
, end
, tem
;
1056 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1058 CHECK_STRING (string
, 0);
1059 if (!list
&& !VECTORP (alist
))
1060 return call3 (alist
, string
, predicate
, Qnil
);
1064 /* If ALIST is not a list, set TAIL just for gc pro. */
1069 obsize
= XVECTOR (alist
)->size
;
1070 bucket
= XVECTOR (alist
)->contents
[index
];
1075 /* Get the next element of the alist or obarray. */
1076 /* Exit the loop if the elements are all used up. */
1077 /* elt gets the alist element or symbol.
1078 eltstring gets the name to check as a completion. */
1085 eltstring
= Fcar (elt
);
1090 if (XFASTINT (bucket
) != 0)
1093 eltstring
= Fsymbol_name (elt
);
1094 if (XSYMBOL (bucket
)->next
)
1095 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1097 XSETFASTINT (bucket
, 0);
1099 else if (++index
>= obsize
)
1103 bucket
= XVECTOR (alist
)->contents
[index
];
1108 /* Is this element a possible completion? */
1110 if (STRINGP (eltstring
)
1111 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1112 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1113 make_number (XSTRING (string
)->size
),
1114 string
, make_number (0), Qnil
,
1115 completion_ignore_case
?Qt
: Qnil
),
1119 Lisp_Object regexps
;
1121 XSETFASTINT (zero
, 0);
1123 /* Ignore this element if it fails to match all the regexps. */
1124 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1125 regexps
= XCDR (regexps
))
1127 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1131 if (CONSP (regexps
))
1134 /* Ignore this element if there is a predicate
1135 and the predicate doesn't like it. */
1137 if (!NILP (predicate
))
1139 if (EQ (predicate
, Qcommandp
))
1140 tem
= Fcommandp (elt
);
1143 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
1144 tem
= call1 (predicate
, elt
);
1147 if (NILP (tem
)) continue;
1150 /* Update computation of how much all possible completions match */
1153 if (NILP (bestmatch
))
1155 bestmatch
= eltstring
;
1156 bestmatchsize
= XSTRING (eltstring
)->size
;
1160 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
1161 tem
= Fcompare_strings (bestmatch
, make_number (0),
1162 make_number (compare
),
1163 eltstring
, make_number (0),
1164 make_number (compare
),
1165 completion_ignore_case
? Qt
: Qnil
);
1167 matchsize
= compare
;
1168 else if (XINT (tem
) < 0)
1169 matchsize
= - XINT (tem
) - 1;
1171 matchsize
= XINT (tem
) - 1;
1174 matchsize
= compare
;
1175 if (completion_ignore_case
)
1177 /* If this is an exact match except for case,
1178 use it as the best match rather than one that is not an
1179 exact match. This way, we get the case pattern
1180 of the actual match. */
1181 if ((matchsize
== XSTRING (eltstring
)->size
1182 && matchsize
< XSTRING (bestmatch
)->size
)
1184 /* If there is more than one exact match ignoring case,
1185 and one of them is exact including case,
1187 /* If there is no exact match ignoring case,
1188 prefer a match that does not change the case
1190 ((matchsize
== XSTRING (eltstring
)->size
)
1192 (matchsize
== XSTRING (bestmatch
)->size
)
1193 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1194 make_number (XSTRING (string
)->size
),
1195 string
, make_number (0),
1199 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1200 make_number (XSTRING (string
)->size
),
1201 string
, make_number (0),
1205 bestmatch
= eltstring
;
1207 bestmatchsize
= matchsize
;
1212 if (NILP (bestmatch
))
1213 return Qnil
; /* No completions found */
1214 /* If we are ignoring case, and there is no exact match,
1215 and no additional text was supplied,
1216 don't change the case of what the user typed. */
1217 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
1218 && XSTRING (bestmatch
)->size
> bestmatchsize
)
1219 return minibuf_conform_representation (string
, bestmatch
);
1221 /* Return t if the supplied string is an exact match (counting case);
1222 it does not require any change to be made. */
1223 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
1224 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1225 make_number (bestmatchsize
),
1226 string
, make_number (0),
1227 make_number (bestmatchsize
),
1232 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1233 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1234 return Fsubstring (bestmatch
, zero
, end
);
1237 /* Compare exactly LEN chars of strings at S1 and S2,
1238 ignoring case if appropriate.
1239 Return -1 if strings match,
1240 else number of chars that match at the beginning. */
1244 register unsigned char *s1
, *s2
;
1247 register int l
= len
;
1249 if (completion_ignore_case
)
1251 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1256 while (l
&& *s1
++ == *s2
++)
1263 int match
= len
- l
;
1265 /* Now *--S1 is the unmatching byte. If it is in the middle of
1266 multi-byte form, we must say that the multi-byte character
1267 there doesn't match. */
1268 while (match
&& *--s1
>= 0xA0) match
--;
1273 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1274 "Search for partial matches to STRING in ALIST.\n\
1275 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1276 The value is a list of all the strings from ALIST that match.\n\
1278 ALIST can be an obarray instead of an alist.\n\
1279 Then the print names of all symbols in the obarray are the possible matches.\n\
1281 ALIST can also be a function to do the completion itself.\n\
1282 It receives three arguments: the values STRING, PREDICATE and t.\n\
1283 Whatever it returns becomes the value of `all-completions'.\n\
1285 If optional third argument PREDICATE is non-nil,\n\
1286 it is used to test each possible match.\n\
1287 The match is a candidate only if PREDICATE returns non-nil.\n\
1288 The argument given to PREDICATE is the alist element\n\
1289 or the symbol from the obarray.\n\
1290 Additionally to this predicate, `completion-regexp-list'\n\
1291 is used to further constrain the set of candidates.\n\
1293 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1294 strings in ALIST that start with a space\n\
1295 are ignored unless STRING itself starts with a space.")
1296 (string
, alist
, predicate
, hide_spaces
)
1297 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1299 Lisp_Object tail
, elt
, eltstring
;
1300 Lisp_Object allmatches
;
1301 int list
= CONSP (alist
) || NILP (alist
);
1303 Lisp_Object bucket
, tem
;
1304 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1306 CHECK_STRING (string
, 0);
1307 if (!list
&& !VECTORP (alist
))
1309 return call3 (alist
, string
, predicate
, Qt
);
1313 /* If ALIST is not a list, set TAIL just for gc pro. */
1318 obsize
= XVECTOR (alist
)->size
;
1319 bucket
= XVECTOR (alist
)->contents
[index
];
1324 /* Get the next element of the alist or obarray. */
1325 /* Exit the loop if the elements are all used up. */
1326 /* elt gets the alist element or symbol.
1327 eltstring gets the name to check as a completion. */
1334 eltstring
= Fcar (elt
);
1339 if (XFASTINT (bucket
) != 0)
1342 eltstring
= Fsymbol_name (elt
);
1343 if (XSYMBOL (bucket
)->next
)
1344 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1346 XSETFASTINT (bucket
, 0);
1348 else if (++index
>= obsize
)
1352 bucket
= XVECTOR (alist
)->contents
[index
];
1357 /* Is this element a possible completion? */
1359 if (STRINGP (eltstring
)
1360 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1361 /* If HIDE_SPACES, reject alternatives that start with space
1362 unless the input starts with space. */
1363 && ((STRING_BYTES (XSTRING (string
)) > 0
1364 && XSTRING (string
)->data
[0] == ' ')
1365 || XSTRING (eltstring
)->data
[0] != ' '
1366 || NILP (hide_spaces
))
1367 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1368 make_number (XSTRING (string
)->size
),
1369 string
, make_number (0),
1370 make_number (XSTRING (string
)->size
),
1371 completion_ignore_case
? Qt
: Qnil
),
1375 Lisp_Object regexps
;
1377 XSETFASTINT (zero
, 0);
1379 /* Ignore this element if it fails to match all the regexps. */
1380 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1381 regexps
= XCDR (regexps
))
1383 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1387 if (CONSP (regexps
))
1390 /* Ignore this element if there is a predicate
1391 and the predicate doesn't like it. */
1393 if (!NILP (predicate
))
1395 if (EQ (predicate
, Qcommandp
))
1396 tem
= Fcommandp (elt
);
1399 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1400 tem
= call1 (predicate
, elt
);
1403 if (NILP (tem
)) continue;
1405 /* Ok => put it on the list. */
1406 allmatches
= Fcons (eltstring
, allmatches
);
1410 return Fnreverse (allmatches
);
1413 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1414 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1415 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1416 Lisp_Object Vminibuffer_completing_file_name
;
1418 /* This comment supplies the doc string for completing-read,
1419 for make-docfile to see. We cannot put this in the real DEFUN
1420 due to limits in the Unix cpp.
1422 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1423 "Read a string in the minibuffer, with completion.\n\
1424 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1425 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1426 TABLE can also be a function to do the completion itself.\n\
1427 PREDICATE limits completion to a subset of TABLE.\n\
1428 See `try-completion' and `all-completions' for more details\n\
1429 on completion, TABLE, and PREDICATE.\n\
1431 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1432 the input is (or completes to) an element of TABLE or is null.\n\
1433 If it is also not t, Return does not exit if it does non-null completion.\n\
1434 If the input is null, `completing-read' returns an empty string,\n\
1435 regardless of the value of REQUIRE-MATCH.\n\
1437 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1438 If it is (STRING . POSITION), the initial input\n\
1439 is STRING, but point is placed POSITION characters into the string.\n\
1440 HIST, if non-nil, specifies a history list\n\
1441 and optionally the initial position in the list.\n\
1442 It can be a symbol, which is the history list variable to use,\n\
1443 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1444 In that case, HISTVAR is the history list variable to use,\n\
1445 and HISTPOS is the initial position (the position in the list\n\
1446 which INITIAL-INPUT corresponds to).\n\
1447 Positions are counted starting from 1 at the beginning of the list.\n\
1448 DEF, if non-nil, is the default value.\n\
1450 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1451 the current input method and the setting of enable-multibyte-characters.\n\
1453 Completion ignores case if the ambient value of\n\
1454 `completion-ignore-case' is non-nil."
1456 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1457 0 /* See immediately above */)
1458 (prompt
, table
, predicate
, require_match
, initial_input
, hist
, def
, inherit_input_method
)
1459 Lisp_Object prompt
, table
, predicate
, require_match
, initial_input
;
1460 Lisp_Object hist
, def
, inherit_input_method
;
1462 Lisp_Object val
, histvar
, histpos
, position
;
1465 int count
= specpdl_ptr
- specpdl
;
1466 struct gcpro gcpro1
;
1468 init
= initial_input
;
1471 specbind (Qminibuffer_completion_table
, table
);
1472 specbind (Qminibuffer_completion_predicate
, predicate
);
1473 specbind (Qminibuffer_completion_confirm
,
1474 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1475 last_exact_completion
= Qnil
;
1482 position
= Fcdr (init
);
1485 CHECK_STRING (init
, 0);
1486 if (!NILP (position
))
1488 CHECK_NUMBER (position
, 0);
1489 /* Convert to distance from end of input. */
1490 pos
= XINT (position
) - XSTRING (init
)->size
;
1501 histvar
= Fcar_safe (hist
);
1502 histpos
= Fcdr_safe (hist
);
1505 histvar
= Qminibuffer_history
;
1507 XSETFASTINT (histpos
, 0);
1509 val
= read_minibuf (NILP (require_match
)
1510 ? Vminibuffer_local_completion_map
1511 : Vminibuffer_local_must_match_map
,
1512 init
, prompt
, make_number (pos
), 0,
1513 histvar
, histpos
, def
, 0,
1514 !NILP (inherit_input_method
));
1516 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1519 RETURN_UNGCPRO (unbind_to (count
, val
));
1522 Lisp_Object
Fminibuffer_completion_help ();
1523 Lisp_Object
assoc_for_completion ();
1525 /* Test whether TXT is an exact completion. */
1527 test_completion (txt
)
1532 if (CONSP (Vminibuffer_completion_table
)
1533 || NILP (Vminibuffer_completion_table
))
1534 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1535 else if (VECTORP (Vminibuffer_completion_table
))
1537 /* Bypass intern-soft as that loses for nil */
1538 tem
= oblookup (Vminibuffer_completion_table
,
1539 XSTRING (txt
)->data
,
1540 XSTRING (txt
)->size
,
1541 STRING_BYTES (XSTRING (txt
)));
1544 if (STRING_MULTIBYTE (txt
))
1545 txt
= Fstring_make_unibyte (txt
);
1547 txt
= Fstring_make_multibyte (txt
);
1549 tem
= oblookup (Vminibuffer_completion_table
,
1550 XSTRING (txt
)->data
,
1551 XSTRING (txt
)->size
,
1552 STRING_BYTES (XSTRING (txt
)));
1556 if (!NILP (Vminibuffer_completion_predicate
))
1557 return call1 (Vminibuffer_completion_predicate
, tem
);
1562 return call3 (Vminibuffer_completion_table
, txt
,
1563 Vminibuffer_completion_predicate
, Qlambda
);
1567 * 0 no possible completion
1568 * 1 was already an exact and unique completion
1569 * 3 was already an exact completion
1570 * 4 completed to an exact completion
1571 * 5 some completion happened
1572 * 6 no completion happened
1577 Lisp_Object completion
, string
, tem
;
1580 struct gcpro gcpro1
, gcpro2
;
1582 completion
= Ftry_completion (Ffield_string (make_number (ZV
)),
1583 Vminibuffer_completion_table
,
1584 Vminibuffer_completion_predicate
);
1585 last
= last_exact_completion
;
1586 last_exact_completion
= Qnil
;
1588 GCPRO2 (completion
, last
);
1590 if (NILP (completion
))
1593 temp_echo_area_glyphs (" [No match]");
1598 if (EQ (completion
, Qt
)) /* exact and unique match */
1604 string
= Ffield_string (make_number (ZV
));
1606 /* COMPLETEDP should be true if some completion was done, which
1607 doesn't include simply changing the case of the entered string.
1608 However, for appearance, the string is rewritten if the case
1610 tem
= Fcompare_strings (completion
, Qnil
, Qnil
, string
, Qnil
, Qnil
, Qt
);
1611 completedp
= !EQ (tem
, Qt
);
1613 tem
= Fstring_equal (completion
, string
);
1615 /* Rewrite the user's input. */
1617 Fdelete_field (make_number (ZV
)); /* Some completion happened */
1618 Finsert (1, &completion
);
1621 /* It did find a match. Do we match some possibility exactly now? */
1622 tem
= test_completion (Ffield_string (make_number (ZV
)));
1625 /* not an exact match */
1630 Fminibuffer_completion_help ();
1632 temp_echo_area_glyphs (" [Next char not unique]");
1635 else if (completedp
)
1640 /* If the last exact completion and this one were the same,
1641 it means we've already given a "Complete but not unique"
1642 message and the user's hit TAB again, so now we give him help. */
1643 last_exact_completion
= completion
;
1646 tem
= Ffield_string (make_number (ZV
));
1647 if (!NILP (Fequal (tem
, last
)))
1648 Fminibuffer_completion_help ();
1654 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1657 assoc_for_completion (key
, list
)
1658 register Lisp_Object key
;
1661 register Lisp_Object tail
;
1663 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1665 register Lisp_Object elt
, tem
, thiscar
;
1667 if (!CONSP (elt
)) continue;
1668 thiscar
= Fcar (elt
);
1669 if (!STRINGP (thiscar
))
1671 tem
= Fcompare_strings (thiscar
, make_number (0), Qnil
,
1672 key
, make_number (0), Qnil
,
1673 completion_ignore_case
? Qt
: Qnil
);
1681 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1682 "Complete the minibuffer contents as far as possible.\n\
1683 Return nil if there is no valid completion, else t.\n\
1684 If no characters can be completed, display a list of possible completions.\n\
1685 If you repeat this command after it displayed such a list,\n\
1686 scroll the window of possible completions.")
1690 Lisp_Object window
, tem
;
1692 /* If the previous command was not this,
1693 mark the completion buffer obsolete. */
1694 if (! EQ (current_kboard
->Vlast_command
, Vthis_command
))
1695 Vminibuf_scroll_window
= Qnil
;
1697 window
= Vminibuf_scroll_window
;
1698 /* If there's a fresh completion window with a live buffer,
1699 and this command is repeated, scroll that window. */
1700 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1701 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1703 struct buffer
*obuf
= current_buffer
;
1705 Fset_buffer (XWINDOW (window
)->buffer
);
1706 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1708 /* If end is in view, scroll up to the beginning. */
1709 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1711 /* Else scroll down one screen. */
1712 Fscroll_other_window (Qnil
);
1714 set_buffer_internal (obuf
);
1718 i
= do_completion ();
1726 Fgoto_char (make_number (ZV
));
1727 temp_echo_area_glyphs (" [Sole completion]");
1732 Fgoto_char (make_number (ZV
));
1733 temp_echo_area_glyphs (" [Complete, but not unique]");
1740 /* Subroutines of Fminibuffer_complete_and_exit. */
1742 /* This one is called by internal_condition_case to do the real work. */
1745 complete_and_exit_1 ()
1747 return make_number (do_completion ());
1750 /* This one is called by internal_condition_case if an error happens.
1751 Pretend the current value is an exact match. */
1754 complete_and_exit_2 (ignore
)
1757 return make_number (1);
1760 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1761 Sminibuffer_complete_and_exit
, 0, 0, "",
1762 "If the minibuffer contents is a valid completion then exit.\n\
1763 Otherwise try to complete it. If completion leads to a valid completion,\n\
1764 a repetition of this command will exit.")
1770 /* Allow user to specify null string */
1771 if (XINT (Ffield_beginning (make_number (ZV
), Qnil
)) == ZV
)
1774 if (!NILP (test_completion (Ffield_string (make_number (ZV
)))))
1777 /* Call do_completion, but ignore errors. */
1778 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1779 complete_and_exit_2
);
1789 if (!NILP (Vminibuffer_completion_confirm
))
1791 temp_echo_area_glyphs (" [Confirm]");
1801 Fthrow (Qexit
, Qnil
);
1805 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1807 "Complete the minibuffer contents at most a single word.\n\
1808 After one word is completed as much as possible, a space or hyphen\n\
1809 is added, provided that matches some possible completion.\n\
1810 Return nil if there is no valid completion, else t.")
1813 Lisp_Object completion
, tem
, tem1
;
1814 register int i
, i_byte
;
1815 register unsigned char *completion_string
;
1816 struct gcpro gcpro1
, gcpro2
;
1817 int prompt_end_charpos
;
1819 /* We keep calling Fbuffer_string rather than arrange for GC to
1820 hold onto a pointer to one of the strings thus made. */
1822 completion
= Ftry_completion (Ffield_string (make_number (ZV
)),
1823 Vminibuffer_completion_table
,
1824 Vminibuffer_completion_predicate
);
1825 if (NILP (completion
))
1828 temp_echo_area_glyphs (" [No match]");
1831 if (EQ (completion
, Qt
))
1834 #if 0 /* How the below code used to look, for reference. */
1835 tem
= Ffield_string (make_number (ZV
));
1836 b
= XSTRING (tem
)->data
;
1837 i
= ZV
- 1 - XSTRING (completion
)->size
;
1838 p
= XSTRING (completion
)->data
;
1840 0 <= scmp (b
, p
, ZV
- 1))
1843 /* Set buffer to longest match of buffer tail and completion head. */
1844 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1846 del_range (1, i
+ 1);
1849 #else /* Rewritten code */
1851 int buffer_nchars
, completion_nchars
;
1853 CHECK_STRING (completion
, 0);
1854 tem
= Ffield_string (make_number (ZV
));
1855 GCPRO2 (completion
, tem
);
1856 /* If reading a file name,
1857 expand any $ENVVAR refs in the buffer and in TEM. */
1858 if (! NILP (Vminibuffer_completing_file_name
))
1860 Lisp_Object substituted
;
1861 substituted
= Fsubstitute_in_file_name (tem
);
1862 if (! EQ (substituted
, tem
))
1865 Fdelete_field (make_number (ZV
));
1866 insert_from_string (tem
, 0, 0, XSTRING (tem
)->size
,
1867 STRING_BYTES (XSTRING (tem
)), 0);
1870 buffer_nchars
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1871 completion_nchars
= XSTRING (completion
)->size
;
1872 i
= buffer_nchars
- completion_nchars
;
1875 (tem1
= Fcompare_strings (tem
, make_number (0),
1876 make_number (buffer_nchars
),
1877 completion
, make_number (0),
1878 make_number (buffer_nchars
),
1879 completion_ignore_case
? Qt
: Qnil
),
1884 /* Set buffer to longest match of buffer tail and completion head. */
1890 tem1
= Fcompare_strings (tem
, make_number (start_pos
), Qnil
,
1891 completion
, make_number (0),
1892 make_number (buffer_nchars
),
1893 completion_ignore_case
? Qt
: Qnil
);
1900 del_range (1, i
+ 1);
1901 SET_PT_BOTH (ZV
, ZV_BYTE
);
1905 #endif /* Rewritten code */
1907 prompt_end_charpos
= XINT (Ffield_beginning (make_number (ZV
), Qnil
));
1910 int prompt_end_bytepos
;
1911 prompt_end_bytepos
= CHAR_TO_BYTE (prompt_end_charpos
);
1912 i
= ZV
- prompt_end_charpos
;
1913 i_byte
= ZV_BYTE
- prompt_end_bytepos
;
1916 /* If completion finds next char not unique,
1917 consider adding a space or a hyphen. */
1918 if (i
== XSTRING (completion
)->size
)
1920 GCPRO1 (completion
);
1921 tem
= Ftry_completion (concat2 (Ffield_string (make_number (ZV
)), build_string (" ")),
1922 Vminibuffer_completion_table
,
1923 Vminibuffer_completion_predicate
);
1930 GCPRO1 (completion
);
1932 Ftry_completion (concat2 (Ffield_string (make_number (ZV
)), build_string ("-")),
1933 Vminibuffer_completion_table
,
1934 Vminibuffer_completion_predicate
);
1942 /* Now find first word-break in the stuff found by completion.
1943 i gets index in string of where to stop completing. */
1946 int bytes
= STRING_BYTES (XSTRING (completion
));
1947 completion_string
= XSTRING (completion
)->data
;
1948 for (; i_byte
< STRING_BYTES (XSTRING (completion
)); i_byte
+= len
, i
++)
1950 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i_byte
,
1953 if (SYNTAX (c
) != Sword
)
1962 /* If got no characters, print help for user. */
1964 if (i
== ZV
- prompt_end_charpos
)
1967 Fminibuffer_completion_help ();
1971 /* Otherwise insert in minibuffer the chars we got */
1973 Fdelete_field (make_number (ZV
));
1974 insert_from_string (completion
, 0, 0, i
, i_byte
, 1);
1978 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1980 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1981 Each element may be just a symbol or string\n\
1982 or may be a list of two strings to be printed as if concatenated.\n\
1983 `standard-output' must be a buffer.\n\
1984 The actual completion alternatives, as inserted, are given `mouse-face'\n\
1985 properties of `highlight'.\n\
1986 At the end, this runs the normal hook `completion-setup-hook'.\n\
1987 It can find the completion buffer in `standard-output'.")
1989 Lisp_Object completions
;
1991 Lisp_Object tail
, elt
;
1994 struct gcpro gcpro1
, gcpro2
;
1995 struct buffer
*old
= current_buffer
;
1998 /* Note that (when it matters) every variable
1999 points to a non-string that is pointed to by COMPLETIONS,
2000 except for ELT. ELT can be pointing to a string
2001 when terpri or Findent_to calls a change hook. */
2003 GCPRO2 (completions
, elt
);
2005 if (BUFFERP (Vstandard_output
))
2006 set_buffer_internal (XBUFFER (Vstandard_output
));
2008 if (NILP (completions
))
2009 write_string ("There are no possible completions of what you have typed.",
2013 write_string ("Possible completions are:", -1);
2014 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
2016 Lisp_Object tem
, string
;
2018 Lisp_Object startpos
, endpos
;
2021 /* Compute the length of this element. */
2025 CHECK_STRING (tem
, 0);
2026 length
= XSTRING (tem
)->size
;
2028 tem
= Fcar (XCDR (elt
));
2029 CHECK_STRING (tem
, 0);
2030 length
+= XSTRING (tem
)->size
;
2034 CHECK_STRING (elt
, 0);
2035 length
= XSTRING (elt
)->size
;
2038 /* This does a bad job for narrower than usual windows.
2039 Sadly, the window it will appear in is not known
2040 until after the text has been made. */
2042 if (BUFFERP (Vstandard_output
))
2043 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2045 /* If the previous completion was very wide,
2046 or we have two on this line already,
2047 don't put another on the same line. */
2048 if (column
> 33 || first
2049 /* If this is really wide, don't put it second on a line. */
2050 || (column
> 0 && length
> 45))
2055 /* Otherwise advance to column 35. */
2058 if (BUFFERP (Vstandard_output
))
2060 tem
= Findent_to (make_number (35), make_number (2));
2062 column
= XINT (tem
);
2068 write_string (" ", -1);
2071 while (column
< 35);
2075 if (BUFFERP (Vstandard_output
))
2077 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2078 Fset_text_properties (startpos
, endpos
,
2079 Qnil
, Vstandard_output
);
2082 /* Output this element.
2083 If necessary, convert it to unibyte or to multibyte first. */
2085 string
= Fcar (elt
);
2088 if (NILP (current_buffer
->enable_multibyte_characters
)
2089 && STRING_MULTIBYTE (string
))
2090 string
= Fstring_make_unibyte (string
);
2091 else if (!NILP (current_buffer
->enable_multibyte_characters
)
2092 && !STRING_MULTIBYTE (string
))
2093 string
= Fstring_make_multibyte (string
);
2095 if (BUFFERP (Vstandard_output
))
2097 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2099 Fprinc (string
, Qnil
);
2101 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2103 Fput_text_property (startpos
, endpos
,
2104 Qmouse_face
, intern ("highlight"),
2109 Fprinc (string
, Qnil
);
2112 /* Output the annotation for this element. */
2115 if (BUFFERP (Vstandard_output
))
2117 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2119 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2121 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2123 Fset_text_properties (startpos
, endpos
, Qnil
,
2128 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2133 /* Update COLUMN for what we have output. */
2136 /* If output is to a buffer, recompute COLUMN in a way
2137 that takes account of character widths. */
2138 if (BUFFERP (Vstandard_output
))
2140 tem
= Fcurrent_column ();
2141 column
= XINT (tem
);
2150 if (BUFFERP (Vstandard_output
))
2151 set_buffer_internal (old
);
2153 if (!NILP (Vrun_hooks
))
2154 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
2159 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
2161 "Display a list of possible completions of the current minibuffer contents.")
2164 Lisp_Object completions
;
2166 message ("Making completion list...");
2167 completions
= Fall_completions (Ffield_string (make_number (ZV
)),
2168 Vminibuffer_completion_table
,
2169 Vminibuffer_completion_predicate
,
2171 clear_message (1, 0);
2173 if (NILP (completions
))
2176 temp_echo_area_glyphs (" [No completions]");
2179 internal_with_output_to_temp_buffer ("*Completions*",
2180 Fdisplay_completion_list
,
2181 Fsort (completions
, Qstring_lessp
));
2185 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
2186 "Terminate minibuffer input.")
2189 if (INTEGERP (last_command_char
))
2190 internal_self_insert (XINT (last_command_char
), 0);
2194 Fthrow (Qexit
, Qnil
);
2197 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
2198 "Terminate this minibuffer argument.")
2201 Fthrow (Qexit
, Qnil
);
2204 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
2205 "Return current depth of activations of minibuffer, a nonnegative integer.")
2208 return make_number (minibuf_level
);
2211 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
2212 "Return the prompt string of the currently-active minibuffer.\n\
2213 If no minibuffer is active, return nil.")
2216 return Fcopy_sequence (minibuf_prompt
);
2220 /* Temporarily display the string M at the end of the current
2221 minibuffer contents. This is used to display things like
2222 "[No Match]" when the user requests a completion for a prefix
2223 that has no possible completions, and other quick, unobtrusive
2227 temp_echo_area_glyphs (m
)
2231 int osize_byte
= ZV_BYTE
;
2233 int opoint_byte
= PT_BYTE
;
2234 Lisp_Object oinhibit
;
2235 oinhibit
= Vinhibit_quit
;
2237 /* Clear out any old echo-area message to make way for our new thing. */
2240 SET_PT_BOTH (osize
, osize_byte
);
2242 SET_PT_BOTH (opoint
, opoint_byte
);
2244 Fsit_for (make_number (2), Qnil
, Qnil
);
2245 del_range_both (osize
, osize_byte
, ZV
, ZV_BYTE
, 1);
2246 SET_PT_BOTH (opoint
, opoint_byte
);
2247 if (!NILP (Vquit_flag
))
2250 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
2252 Vinhibit_quit
= oinhibit
;
2255 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
2257 "Temporarily display STRING at the end of the minibuffer.\n\
2258 The text is displayed for two seconds,\n\
2259 or until the next input event arrives, whichever comes first.")
2263 temp_echo_area_glyphs (XSTRING (string
)->data
);
2268 init_minibuf_once ()
2270 Vminibuffer_list
= Qnil
;
2271 staticpro (&Vminibuffer_list
);
2278 minibuf_prompt
= Qnil
;
2279 staticpro (&minibuf_prompt
);
2281 minibuf_save_list
= Qnil
;
2282 staticpro (&minibuf_save_list
);
2284 Qread_file_name_internal
= intern ("read-file-name-internal");
2285 staticpro (&Qread_file_name_internal
);
2287 Qminibuffer_default
= intern ("minibuffer-default");
2288 staticpro (&Qminibuffer_default
);
2289 Fset (Qminibuffer_default
, Qnil
);
2291 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
2292 staticpro (&Qminibuffer_completion_table
);
2294 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
2295 staticpro (&Qminibuffer_completion_confirm
);
2297 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
2298 staticpro (&Qminibuffer_completion_predicate
);
2300 staticpro (&last_exact_completion
);
2301 last_exact_completion
= Qnil
;
2303 staticpro (&last_minibuf_string
);
2304 last_minibuf_string
= Qnil
;
2306 Quser_variable_p
= intern ("user-variable-p");
2307 staticpro (&Quser_variable_p
);
2309 Qminibuffer_history
= intern ("minibuffer-history");
2310 staticpro (&Qminibuffer_history
);
2312 Qbuffer_name_history
= intern ("buffer-name-history");
2313 staticpro (&Qbuffer_name_history
);
2314 Fset (Qbuffer_name_history
, Qnil
);
2316 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2317 staticpro (&Qminibuffer_setup_hook
);
2319 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2320 staticpro (&Qminibuffer_exit_hook
);
2322 Qhistory_length
= intern ("history-length");
2323 staticpro (&Qhistory_length
);
2325 Qcurrent_input_method
= intern ("current-input-method");
2326 staticpro (&Qcurrent_input_method
);
2328 Qactivate_input_method
= intern ("activate-input-method");
2329 staticpro (&Qactivate_input_method
);
2331 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2332 "If this is non-nil, `read-buffer' does its work by calling this function.");
2333 Vread_buffer_function
= Qnil
;
2335 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2336 "Normal hook run just after entry to minibuffer.");
2337 Vminibuffer_setup_hook
= Qnil
;
2339 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2340 "Normal hook run just after exit from minibuffer.");
2341 Vminibuffer_exit_hook
= Qnil
;
2343 DEFVAR_LISP ("history-length", &Vhistory_length
,
2344 "*Maximum length for history lists before truncation takes place.\n\
2345 A number means that length; t means infinite. Truncation takes place\n\
2346 just after a new element is inserted. Setting the history-length\n\
2347 property of a history variable overrides this default.");
2348 XSETFASTINT (Vhistory_length
, 30);
2350 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
2351 "*Non-nil means automatically provide help for invalid completion input.");
2354 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2355 "Non-nil means don't consider case significant in completion.");
2356 completion_ignore_case
= 0;
2358 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2359 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2360 This variable makes a difference whenever the minibuffer window is active.");
2361 enable_recursive_minibuffers
= 0;
2363 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2364 "Alist or obarray used for completion in the minibuffer.\n\
2365 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2367 The value may alternatively be a function, which is given three arguments:\n\
2368 STRING, the current buffer contents;\n\
2369 PREDICATE, the predicate for filtering possible matches;\n\
2370 CODE, which says what kind of things to do.\n\
2371 CODE can be nil, t or `lambda'.\n\
2372 nil means to return the best completion of STRING, or nil if there is none.\n\
2373 t means to return a list of all possible completions of STRING.\n\
2374 `lambda' means to return t if STRING is a valid completion as it stands.");
2375 Vminibuffer_completion_table
= Qnil
;
2377 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2378 "Within call to `completing-read', this holds the PREDICATE argument.");
2379 Vminibuffer_completion_predicate
= Qnil
;
2381 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2382 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2383 Vminibuffer_completion_confirm
= Qnil
;
2385 DEFVAR_LISP ("minibuffer-completing-file-name",
2386 &Vminibuffer_completing_file_name
,
2387 "Non-nil means completing file names.");
2388 Vminibuffer_completing_file_name
= Qnil
;
2390 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2391 "Value that `help-form' takes on inside the minibuffer.");
2392 Vminibuffer_help_form
= Qnil
;
2394 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2395 "History list symbol to add minibuffer values to.\n\
2396 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2398 (set minibuffer-history-variable\n\
2399 (cons STRING (symbol-value minibuffer-history-variable)))");
2400 XSETFASTINT (Vminibuffer_history_variable
, 0);
2402 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2403 "Current position of redoing in the history list.");
2404 Vminibuffer_history_position
= Qnil
;
2406 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2407 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2408 Some uses of the echo area also raise that frame (since they use it too).");
2409 minibuffer_auto_raise
= 0;
2411 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2412 "List of regexps that should restrict possible completions.");
2413 Vcompletion_regexp_list
= Qnil
;
2415 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2416 &minibuffer_allow_text_properties
,
2417 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2418 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2419 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2420 with completion; they always discard text properties.");
2421 minibuffer_allow_text_properties
= 0;
2423 defsubr (&Sset_minibuffer_window
);
2424 defsubr (&Sread_from_minibuffer
);
2425 defsubr (&Seval_minibuffer
);
2426 defsubr (&Sread_minibuffer
);
2427 defsubr (&Sread_string
);
2428 defsubr (&Sread_command
);
2429 defsubr (&Sread_variable
);
2430 defsubr (&Sread_buffer
);
2431 defsubr (&Sread_no_blanks_input
);
2432 defsubr (&Sminibuffer_depth
);
2433 defsubr (&Sminibuffer_prompt
);
2435 defsubr (&Stry_completion
);
2436 defsubr (&Sall_completions
);
2437 defsubr (&Scompleting_read
);
2438 defsubr (&Sminibuffer_complete
);
2439 defsubr (&Sminibuffer_complete_word
);
2440 defsubr (&Sminibuffer_complete_and_exit
);
2441 defsubr (&Sdisplay_completion_list
);
2442 defsubr (&Sminibuffer_completion_help
);
2444 defsubr (&Sself_insert_and_exit
);
2445 defsubr (&Sexit_minibuffer
);
2447 defsubr (&Sminibuffer_message
);
2453 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2454 "abort-recursive-edit");
2455 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2457 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2460 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2461 "abort-recursive-edit");
2462 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2464 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2467 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2469 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2471 initial_define_key (Vminibuffer_local_ns_map
, '?',
2472 "self-insert-and-exit");
2474 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2475 "abort-recursive-edit");
2476 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2478 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2481 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2482 "minibuffer-complete");
2483 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2484 "minibuffer-complete-word");
2485 initial_define_key (Vminibuffer_local_completion_map
, '?',
2486 "minibuffer-completion-help");
2488 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2489 "abort-recursive-edit");
2490 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2491 "minibuffer-complete-and-exit");
2492 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2493 "minibuffer-complete-and-exit");
2494 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2495 "minibuffer-complete");
2496 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2497 "minibuffer-complete-word");
2498 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2499 "minibuffer-completion-help");