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
;
279 struct gcpro gcpro1
, gcpro2
;
282 fprintf (stdout
, "%s", XSTRING (prompt
)->data
);
287 line
= (char *) xmalloc (size
* sizeof *line
);
288 while ((s
= fgets (line
+ len
, size
- len
, stdin
)) != NULL
289 && (len
= strlen (line
),
290 len
== size
- 1 && line
[len
- 1] != '\n'))
293 line
= (char *) xrealloc (line
, size
);
300 if (len
> 0 && line
[len
- 1] == '\n')
303 val
= build_string (line
);
309 error ("Error reading from stdin");
312 /* If Lisp form desired instead of string, parse it. */
314 val
= string_to_object (val
, defalt
);
320 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
321 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
322 prompting with PROMPT (a string), using history list HISTVAR
323 with initial position HISTPOS. (BACKUP_N should be <= 0.)
325 Normally return the result as a string (the text that was read),
326 but if EXPFLAG is nonzero, read it and return the object read.
327 If HISTVAR is given, save the value read on that history only if it doesn't
328 match the front of that history list exactly. The value is pushed onto
329 the list as the string that was read.
331 DEFALT specifies te default value for the sake of history commands.
333 If ALLOW_PROPS is nonzero, we do not throw away text properties.
335 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
336 current input method. */
339 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
340 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
344 Lisp_Object backup_n
;
350 int inherit_input_method
;
353 int count
= specpdl_ptr
- specpdl
;
354 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
355 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
356 Lisp_Object enable_multibyte
;
357 extern Lisp_Object Qread_only
, Qfront_sticky
;
358 extern Lisp_Object Qrear_nonsticky
;
360 specbind (Qminibuffer_default
, defalt
);
362 single_kboard_state ();
365 ambient_dir
= current_buffer
->directory
;
367 enable_multibyte
= Qnil
;
369 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
370 store them away before we can GC. Don't need to protect
371 BACKUP_N because we use the value only if it is an integer. */
372 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
374 if (!STRINGP (prompt
))
375 prompt
= build_string ("");
377 if (!enable_recursive_minibuffers
378 && minibuf_level
> 0)
380 if (EQ (selected_window
, minibuf_window
))
381 error ("Command attempted to use minibuffer while in minibuffer");
383 /* If we're in another window, cancel the minibuffer that's active. */
385 build_string ("Command attempted to use minibuffer while in minibuffer"));
389 return read_minibuf_noninteractive (map
, initial
, prompt
, backup_n
,
390 expflag
, histvar
, histpos
, defalt
,
391 allow_props
, inherit_input_method
);
393 /* Choose the minibuffer window and frame, and take action on them. */
395 choose_minibuf_frame ();
397 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
399 record_unwind_protect (Fset_window_configuration
,
400 Fcurrent_window_configuration (Qnil
));
402 /* If the minibuffer window is on a different frame, save that
403 frame's configuration too. */
404 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
405 if (!EQ (mini_frame
, selected_frame
))
406 record_unwind_protect (Fset_window_configuration
,
407 Fcurrent_window_configuration (mini_frame
));
409 /* If the minibuffer is on an iconified or invisible frame,
410 make it visible now. */
411 Fmake_frame_visible (mini_frame
);
413 if (minibuffer_auto_raise
)
414 Fraise_frame (mini_frame
);
416 /* We have to do this after saving the window configuration
417 since that is what restores the current buffer. */
419 /* Arrange to restore a number of minibuffer-related variables.
420 We could bind each variable separately, but that would use lots of
423 = Fcons (Voverriding_local_map
,
424 Fcons (minibuf_window
, minibuf_save_list
));
426 = Fcons (minibuf_prompt
,
427 Fcons (make_number (minibuf_prompt_width
),
429 Fcons (Vcurrent_prefix_arg
,
430 Fcons (Vminibuffer_history_position
,
431 Fcons (Vminibuffer_history_variable
,
432 minibuf_save_list
))))));
434 record_unwind_protect (read_minibuf_unwind
, Qnil
);
437 /* Now that we can restore all those variables, start changing them. */
439 minibuf_prompt_width
= 0;
440 minibuf_prompt
= Fcopy_sequence (prompt
);
441 Vminibuffer_history_position
= histpos
;
442 Vminibuffer_history_variable
= histvar
;
443 Vhelp_form
= Vminibuffer_help_form
;
445 if (inherit_input_method
)
447 /* `current-input-method' is buffer local. So, remeber it in
448 INPUT_METHOD before changing the current buffer. */
449 input_method
= Fsymbol_value (Qcurrent_input_method
);
450 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
453 /* Switch to the minibuffer. */
455 minibuffer
= get_minibuffer (minibuf_level
);
456 Fset_buffer (minibuffer
);
458 /* The current buffer's default directory is usually the right thing
459 for our minibuffer here. However, if you're typing a command at
460 a minibuffer-only frame when minibuf_level is zero, then buf IS
461 the current_buffer, so reset_buffer leaves buf's default
462 directory unchanged. This is a bummer when you've just started
463 up Emacs and buf's default directory is Qnil. Here's a hack; can
464 you think of something better to do? Find another buffer with a
465 better directory, and use that one instead. */
466 if (STRINGP (ambient_dir
))
467 current_buffer
->directory
= ambient_dir
;
470 Lisp_Object buf_list
;
472 for (buf_list
= Vbuffer_alist
;
474 buf_list
= XCDR (buf_list
))
476 Lisp_Object other_buf
;
478 other_buf
= XCDR (XCAR (buf_list
));
479 if (STRINGP (XBUFFER (other_buf
)->directory
))
481 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
487 if (!EQ (mini_frame
, selected_frame
))
488 Fredirect_frame_focus (selected_frame
, mini_frame
);
490 Vminibuf_scroll_window
= selected_window
;
491 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
492 Fselect_window (minibuf_window
);
493 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
495 Fmake_local_variable (Qprint_escape_newlines
);
496 print_escape_newlines
= 1;
498 /* Erase the buffer. */
500 int count1
= specpdl_ptr
- specpdl
;
501 specbind (Qinhibit_read_only
, Qt
);
503 unbind_to (count1
, Qnil
);
506 if (!NILP (current_buffer
->enable_multibyte_characters
)
507 && ! STRING_MULTIBYTE (minibuf_prompt
))
508 minibuf_prompt
= Fstring_make_multibyte (minibuf_prompt
);
510 /* Insert the prompt, record where it ends. */
511 Finsert (1, &minibuf_prompt
);
514 Fput_text_property (make_number (BEG
), make_number (PT
),
515 Qfront_sticky
, Qt
, Qnil
);
516 Fput_text_property (make_number (BEG
), make_number (PT
),
517 Qrear_nonsticky
, Qt
, Qnil
);
518 Fput_text_property (make_number (BEG
), make_number (PT
),
520 Fput_text_property (make_number (BEG
), make_number (PT
),
521 Qread_only
, Qt
, Qnil
);
524 minibuf_prompt_width
= current_column ();
526 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
527 if (inherit_input_method
)
528 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
530 /* Put in the initial input. */
533 Finsert (1, &initial
);
534 if (INTEGERP (backup_n
))
535 Fforward_char (backup_n
);
538 clear_message (1, 1);
539 current_buffer
->keymap
= map
;
541 /* Turn on an input method stored in INPUT_METHOD if any. */
542 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
543 call1 (Qactivate_input_method
, input_method
);
545 /* Run our hook, but not if it is empty.
546 (run-hooks would do nothing if it is empty,
547 but it's important to save time here in the usual case). */
548 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
549 && !NILP (Vrun_hooks
))
550 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
554 /* If cursor is on the minibuffer line,
555 show the user we have exited by putting it in column 0. */
556 if (XWINDOW (minibuf_window
)->cursor
.vpos
>= 0
559 XWINDOW (minibuf_window
)->cursor
.hpos
= 0;
560 XWINDOW (minibuf_window
)->cursor
.x
= 0;
561 XWINDOW (minibuf_window
)->must_be_updated_p
= 1;
562 update_frame (XFRAME (selected_frame
), 1, 1);
563 if (rif
&& rif
->flush_display
)
564 rif
->flush_display (XFRAME (XWINDOW (minibuf_window
)->frame
));
567 /* Make minibuffer contents into a string. */
568 Fset_buffer (minibuffer
);
569 val
= Ffield_string (make_number (ZV
), allow_props
? Qt
: Qnil
);
571 /* VAL is the string of minibuffer text. */
573 last_minibuf_string
= val
;
575 /* Add the value to the appropriate history list unless it is empty. */
576 if (XSTRING (val
)->size
!= 0
577 && SYMBOLP (Vminibuffer_history_variable
))
579 /* If the caller wanted to save the value read on a history list,
580 then do so if the value is not already the front of the list. */
583 /* If variable is unbound, make it nil. */
584 if (EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
585 Fset (Vminibuffer_history_variable
, Qnil
);
587 histval
= Fsymbol_value (Vminibuffer_history_variable
);
589 /* The value of the history variable must be a cons or nil. Other
590 values are unacceptable. We silently ignore these values. */
593 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
597 histval
= Fcons (last_minibuf_string
, histval
);
598 Fset (Vminibuffer_history_variable
, histval
);
600 /* Truncate if requested. */
601 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
602 if (NILP (length
)) length
= Vhistory_length
;
603 if (INTEGERP (length
))
605 if (XINT (length
) <= 0)
606 Fset (Vminibuffer_history_variable
, Qnil
);
611 temp
= Fnthcdr (Fsub1 (length
), histval
);
612 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
618 /* If Lisp form desired instead of string, parse it. */
620 val
= string_to_object (val
, defalt
);
622 /* The appropriate frame will get selected
623 in set-window-configuration. */
624 RETURN_UNGCPRO (unbind_to (count
, val
));
627 /* Return a buffer to be used as the minibuffer at depth `depth'.
628 depth = 0 is the lowest allowed argument, and that is the value
629 used for nonrecursive minibuffer invocations */
632 get_minibuffer (depth
)
635 Lisp_Object tail
, num
, buf
;
637 extern Lisp_Object
nconc2 ();
639 XSETFASTINT (num
, depth
);
640 tail
= Fnthcdr (num
, Vminibuffer_list
);
643 tail
= Fcons (Qnil
, Qnil
);
644 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
647 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
649 sprintf (name
, " *Minibuf-%d*", depth
);
650 buf
= Fget_buffer_create (build_string (name
));
652 /* Although the buffer's name starts with a space, undo should be
654 Fbuffer_enable_undo (buf
);
660 int count
= specpdl_ptr
- specpdl
;
662 reset_buffer (XBUFFER (buf
));
663 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
665 Fkill_all_local_variables ();
666 unbind_to (count
, Qnil
);
672 /* This function is called on exiting minibuffer, whether normally or
673 not, and it restores the current window, buffer, etc. */
676 read_minibuf_unwind (data
)
679 Lisp_Object old_deactivate_mark
;
682 /* We are exiting the minibuffer one way or the other,
684 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
685 && !NILP (Vrun_hooks
))
686 safe_run_hooks (Qminibuffer_exit_hook
);
688 /* If this was a recursive minibuffer,
689 tie the minibuffer window back to the outer level minibuffer buffer. */
692 window
= minibuf_window
;
693 /* To keep things predictable, in case it matters, let's be in the
694 minibuffer when we reset the relevant variables. */
695 Fset_buffer (XWINDOW (window
)->buffer
);
697 /* Restore prompt, etc, from outer minibuffer level. */
698 minibuf_prompt
= Fcar (minibuf_save_list
);
699 minibuf_save_list
= Fcdr (minibuf_save_list
);
700 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
701 minibuf_save_list
= Fcdr (minibuf_save_list
);
702 Vhelp_form
= Fcar (minibuf_save_list
);
703 minibuf_save_list
= Fcdr (minibuf_save_list
);
704 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
705 minibuf_save_list
= Fcdr (minibuf_save_list
);
706 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
707 minibuf_save_list
= Fcdr (minibuf_save_list
);
708 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
709 minibuf_save_list
= Fcdr (minibuf_save_list
);
710 Voverriding_local_map
= Fcar (minibuf_save_list
);
711 minibuf_save_list
= Fcdr (minibuf_save_list
);
713 temp
= Fcar (minibuf_save_list
);
714 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
715 minibuf_window
= temp
;
717 minibuf_save_list
= Fcdr (minibuf_save_list
);
719 /* Erase the minibuffer we were using at this level. */
721 int count
= specpdl_ptr
- specpdl
;
722 /* Prevent error in erase-buffer. */
723 specbind (Qinhibit_read_only
, Qt
);
724 old_deactivate_mark
= Vdeactivate_mark
;
726 Vdeactivate_mark
= old_deactivate_mark
;
727 unbind_to (count
, Qnil
);
730 /* When we get to the outmost level, make sure we resize the
731 mini-window back to its normal size. */
732 if (minibuf_level
== 0)
733 resize_mini_window (XWINDOW (window
), 0);
735 /* Make sure minibuffer window is erased, not ignored. */
736 windows_or_buffers_changed
++;
737 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
738 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
743 /* This comment supplies the doc string for read-from-minibuffer,
744 for make-docfile to see. We cannot put this in the real DEFUN
745 due to limits in the Unix cpp.
747 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
748 "Read a string from the minibuffer, prompting with string PROMPT.\n\
749 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
750 to be inserted into the minibuffer before reading input.\n\
751 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
752 is STRING, but point is placed at position POSITION in the minibuffer.\n\
753 Third arg KEYMAP is a keymap to use whilst reading;\n\
754 if omitted or nil, the default is `minibuffer-local-map'.\n\
755 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
756 and return that object:\n\
757 in other words, do `(car (read-from-string INPUT-STRING))'\n\
758 Fifth arg HIST, if non-nil, specifies a history list\n\
759 and optionally the initial position in the list.\n\
760 It can be a symbol, which is the history list variable to use,\n\
761 or it can be a cons cell (HISTVAR . HISTPOS).\n\
762 In that case, HISTVAR is the history list variable to use,\n\
763 and HISTPOS is the initial position (the position in the list\n\
764 which INITIAL-CONTENTS corresponds to).\n\
765 Positions are counted starting from 1 at the beginning of the list.\n\
766 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
767 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
768 if the user enters empty input! It returns the empty string.\n\
769 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
770 the current input method and the setting of enable-multibyte-characters.\n\
771 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
772 then the string which is returned includes whatever text properties\n\
773 were present in the minibuffer. Otherwise the value has no text properties.")
774 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
777 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
778 0 /* See immediately above */)
779 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
780 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
781 Lisp_Object inherit_input_method
;
784 Lisp_Object histvar
, histpos
, position
, val
;
789 CHECK_STRING (prompt
, 0);
790 if (!NILP (initial_contents
))
792 if (CONSP (initial_contents
))
794 position
= Fcdr (initial_contents
);
795 initial_contents
= Fcar (initial_contents
);
797 CHECK_STRING (initial_contents
, 1);
798 if (!NILP (position
))
800 CHECK_NUMBER (position
, 0);
801 /* Convert to distance from end of input. */
802 if (XINT (position
) < 1)
803 /* A number too small means the beginning of the string. */
804 pos
= - XSTRING (initial_contents
)->size
;
806 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
811 keymap
= Vminibuffer_local_map
;
813 keymap
= get_keymap (keymap
);
822 histvar
= Fcar_safe (hist
);
823 histpos
= Fcdr_safe (hist
);
826 histvar
= Qminibuffer_history
;
828 XSETFASTINT (histpos
, 0);
830 GCPRO1 (default_value
);
831 val
= read_minibuf (keymap
, initial_contents
, prompt
,
832 make_number (pos
), !NILP (read
),
833 histvar
, histpos
, default_value
,
834 minibuffer_allow_text_properties
,
835 !NILP (inherit_input_method
));
840 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
841 "Return a Lisp object read using the minibuffer.\n\
842 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
843 is a string to insert in the minibuffer before reading.")
844 (prompt
, initial_contents
)
845 Lisp_Object prompt
, initial_contents
;
847 CHECK_STRING (prompt
, 0);
848 if (!NILP (initial_contents
))
849 CHECK_STRING (initial_contents
, 1);
850 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
851 prompt
, Qnil
, 1, Qminibuffer_history
,
852 make_number (0), Qnil
, 0, 0);
855 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
856 "Return value of Lisp expression read using the minibuffer.\n\
857 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
858 is a string to insert in the minibuffer before reading.")
859 (prompt
, initial_contents
)
860 Lisp_Object prompt
, initial_contents
;
862 return Feval (Fread_minibuffer (prompt
, initial_contents
));
865 /* Functions that use the minibuffer to read various things. */
867 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
868 "Read a string from the minibuffer, prompting with string PROMPT.\n\
869 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
870 The third arg HISTORY, if non-nil, specifies a history list\n\
871 and optionally the initial position in the list.\n\
872 See `read-from-minibuffer' for details of HISTORY argument.\n\
873 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
874 for history commands, and as the value to return if the user enters\n\
876 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
877 the current input method and the setting of enable-multibyte-characters.")
878 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
879 Lisp_Object prompt
, initial_input
, history
, default_value
;
880 Lisp_Object inherit_input_method
;
883 val
= Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
884 Qnil
, history
, default_value
,
885 inherit_input_method
);
886 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
891 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
892 "Read a string from the terminal, not allowing blanks.\n\
893 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
894 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
895 the current input method and the setting of enable-multibyte-characters.")
896 (prompt
, initial
, inherit_input_method
)
897 Lisp_Object prompt
, initial
, inherit_input_method
;
899 CHECK_STRING (prompt
, 0);
900 if (! NILP (initial
))
901 CHECK_STRING (initial
, 1);
903 return read_minibuf (Vminibuffer_local_ns_map
, initial
, prompt
, Qnil
,
904 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
905 !NILP (inherit_input_method
));
908 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
909 "Read the name of a command and return as a symbol.\n\
910 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
911 (prompt
, default_value
)
912 Lisp_Object prompt
, default_value
;
914 Lisp_Object name
, default_string
;
916 if (NILP (default_value
))
917 default_string
= Qnil
;
918 else if (SYMBOLP (default_value
))
919 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
921 default_string
= default_value
;
923 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
924 Qnil
, Qnil
, default_string
, Qnil
);
927 return Fintern (name
, Qnil
);
931 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
932 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
933 Prompts with PROMPT.")
937 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
942 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
943 "Read the name of a user variable and return it as a symbol.\n\
944 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
945 A user variable is one whose documentation starts with a `*' character.")
946 (prompt
, default_value
)
947 Lisp_Object prompt
, default_value
;
949 Lisp_Object name
, default_string
;
951 if (NILP (default_value
))
952 default_string
= Qnil
;
953 else if (SYMBOLP (default_value
))
954 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
956 default_string
= default_value
;
958 name
= Fcompleting_read (prompt
, Vobarray
,
959 Quser_variable_p
, Qt
,
960 Qnil
, Qnil
, default_string
, Qnil
);
963 return Fintern (name
, Qnil
);
966 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
967 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
968 Prompts with PROMPT.\n\
969 Optional second arg DEF is value to return if user enters an empty line.\n\
970 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
971 (prompt
, def
, require_match
)
972 Lisp_Object prompt
, def
, require_match
;
977 def
= XBUFFER (def
)->name
;
979 if (NILP (Vread_buffer_function
))
983 args
[0] = build_string ("%s(default %s) ");
986 prompt
= Fformat (3, args
);
989 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
990 require_match
, Qnil
, Qbuffer_name_history
,
995 args
[0] = Vread_buffer_function
;
998 args
[3] = require_match
;
999 return Ffuncall(4, args
);
1004 minibuf_conform_representation (string
, basis
)
1005 Lisp_Object string
, basis
;
1007 if (STRING_MULTIBYTE (string
) == STRING_MULTIBYTE (basis
))
1010 if (STRING_MULTIBYTE (string
))
1011 return Fstring_make_unibyte (string
);
1013 return Fstring_make_multibyte (string
);
1016 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
1017 "Return common substring of all completions of STRING in ALIST.\n\
1018 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1019 All that match are compared together; the longest initial sequence\n\
1020 common to all matches is returned as a string.\n\
1021 If there is no match at all, nil is returned.\n\
1022 For a unique match which is exact, t is returned.\n\
1024 ALIST can be an obarray instead of an alist.\n\
1025 Then the print names of all symbols in the obarray are the possible matches.\n\
1027 ALIST can also be a function to do the completion itself.\n\
1028 It receives three arguments: the values STRING, PREDICATE and nil.\n\
1029 Whatever it returns becomes the value of `try-completion'.\n\
1031 If optional third argument PREDICATE is non-nil,\n\
1032 it is used to test each possible match.\n\
1033 The match is a candidate only if PREDICATE returns non-nil.\n\
1034 The argument given to PREDICATE is the alist element\n\
1035 or the symbol from the obarray.")
1036 (string
, alist
, predicate
)
1037 Lisp_Object string
, alist
, predicate
;
1039 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
1040 /* Size in bytes of BESTMATCH. */
1042 /* These are in bytes, too. */
1043 int compare
, matchsize
;
1044 int list
= CONSP (alist
) || NILP (alist
);
1047 Lisp_Object bucket
, zero
, end
, tem
;
1048 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1050 CHECK_STRING (string
, 0);
1051 if (!list
&& !VECTORP (alist
))
1052 return call3 (alist
, string
, predicate
, Qnil
);
1056 /* If ALIST is not a list, set TAIL just for gc pro. */
1061 obsize
= XVECTOR (alist
)->size
;
1062 bucket
= XVECTOR (alist
)->contents
[index
];
1067 /* Get the next element of the alist or obarray. */
1068 /* Exit the loop if the elements are all used up. */
1069 /* elt gets the alist element or symbol.
1070 eltstring gets the name to check as a completion. */
1077 eltstring
= Fcar (elt
);
1082 if (XFASTINT (bucket
) != 0)
1085 eltstring
= Fsymbol_name (elt
);
1086 if (XSYMBOL (bucket
)->next
)
1087 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1089 XSETFASTINT (bucket
, 0);
1091 else if (++index
>= obsize
)
1095 bucket
= XVECTOR (alist
)->contents
[index
];
1100 /* Is this element a possible completion? */
1102 if (STRINGP (eltstring
)
1103 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1104 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1105 make_number (XSTRING (string
)->size
),
1106 string
, make_number (0), Qnil
,
1107 completion_ignore_case
?Qt
: Qnil
),
1111 Lisp_Object regexps
;
1113 XSETFASTINT (zero
, 0);
1115 /* Ignore this element if it fails to match all the regexps. */
1116 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1117 regexps
= XCDR (regexps
))
1119 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1123 if (CONSP (regexps
))
1126 /* Ignore this element if there is a predicate
1127 and the predicate doesn't like it. */
1129 if (!NILP (predicate
))
1131 if (EQ (predicate
, Qcommandp
))
1132 tem
= Fcommandp (elt
);
1135 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
1136 tem
= call1 (predicate
, elt
);
1139 if (NILP (tem
)) continue;
1142 /* Update computation of how much all possible completions match */
1145 if (NILP (bestmatch
))
1147 bestmatch
= eltstring
;
1148 bestmatchsize
= XSTRING (eltstring
)->size
;
1152 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
1153 tem
= Fcompare_strings (bestmatch
, make_number (0),
1154 make_number (compare
),
1155 eltstring
, make_number (0),
1156 make_number (compare
),
1157 completion_ignore_case
? Qt
: Qnil
);
1159 matchsize
= compare
;
1160 else if (XINT (tem
) < 0)
1161 matchsize
= - XINT (tem
) - 1;
1163 matchsize
= XINT (tem
) - 1;
1166 matchsize
= compare
;
1167 if (completion_ignore_case
)
1169 /* If this is an exact match except for case,
1170 use it as the best match rather than one that is not an
1171 exact match. This way, we get the case pattern
1172 of the actual match. */
1173 if ((matchsize
== XSTRING (eltstring
)->size
1174 && matchsize
< XSTRING (bestmatch
)->size
)
1176 /* If there is more than one exact match ignoring case,
1177 and one of them is exact including case,
1179 /* If there is no exact match ignoring case,
1180 prefer a match that does not change the case
1182 ((matchsize
== XSTRING (eltstring
)->size
)
1184 (matchsize
== XSTRING (bestmatch
)->size
)
1185 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1186 make_number (XSTRING (string
)->size
),
1187 string
, make_number (0),
1191 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1192 make_number (XSTRING (string
)->size
),
1193 string
, make_number (0),
1197 bestmatch
= eltstring
;
1199 bestmatchsize
= matchsize
;
1204 if (NILP (bestmatch
))
1205 return Qnil
; /* No completions found */
1206 /* If we are ignoring case, and there is no exact match,
1207 and no additional text was supplied,
1208 don't change the case of what the user typed. */
1209 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
1210 && XSTRING (bestmatch
)->size
> bestmatchsize
)
1211 return minibuf_conform_representation (string
, bestmatch
);
1213 /* Return t if the supplied string is an exact match (counting case);
1214 it does not require any change to be made. */
1215 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
1216 && (tem
= Fcompare_strings (bestmatch
, make_number (0),
1217 make_number (bestmatchsize
),
1218 string
, make_number (0),
1219 make_number (bestmatchsize
),
1224 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1225 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1226 return Fsubstring (bestmatch
, zero
, end
);
1229 /* Compare exactly LEN chars of strings at S1 and S2,
1230 ignoring case if appropriate.
1231 Return -1 if strings match,
1232 else number of chars that match at the beginning. */
1236 register unsigned char *s1
, *s2
;
1239 register int l
= len
;
1241 if (completion_ignore_case
)
1243 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1248 while (l
&& *s1
++ == *s2
++)
1255 int match
= len
- l
;
1257 /* Now *--S1 is the unmatching byte. If it is in the middle of
1258 multi-byte form, we must say that the multi-byte character
1259 there doesn't match. */
1260 while (match
&& *--s1
>= 0xA0) match
--;
1265 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1266 "Search for partial matches to STRING in ALIST.\n\
1267 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1268 The value is a list of all the strings from ALIST that match.\n\
1270 ALIST can be an obarray instead of an alist.\n\
1271 Then the print names of all symbols in the obarray are the possible matches.\n\
1273 ALIST can also be a function to do the completion itself.\n\
1274 It receives three arguments: the values STRING, PREDICATE and t.\n\
1275 Whatever it returns becomes the value of `all-completions'.\n\
1277 If optional third argument PREDICATE is non-nil,\n\
1278 it is used to test each possible match.\n\
1279 The match is a candidate only if PREDICATE returns non-nil.\n\
1280 The argument given to PREDICATE is the alist element\n\
1281 or the symbol from the obarray.\n\
1283 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1284 strings in ALIST that start with a space\n\
1285 are ignored unless STRING itself starts with a space.")
1286 (string
, alist
, predicate
, hide_spaces
)
1287 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1289 Lisp_Object tail
, elt
, eltstring
;
1290 Lisp_Object allmatches
;
1291 int list
= CONSP (alist
) || NILP (alist
);
1293 Lisp_Object bucket
, tem
;
1294 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1296 CHECK_STRING (string
, 0);
1297 if (!list
&& !VECTORP (alist
))
1299 return call3 (alist
, string
, predicate
, Qt
);
1303 /* If ALIST is not a list, set TAIL just for gc pro. */
1308 obsize
= XVECTOR (alist
)->size
;
1309 bucket
= XVECTOR (alist
)->contents
[index
];
1314 /* Get the next element of the alist or obarray. */
1315 /* Exit the loop if the elements are all used up. */
1316 /* elt gets the alist element or symbol.
1317 eltstring gets the name to check as a completion. */
1324 eltstring
= Fcar (elt
);
1329 if (XFASTINT (bucket
) != 0)
1332 eltstring
= Fsymbol_name (elt
);
1333 if (XSYMBOL (bucket
)->next
)
1334 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1336 XSETFASTINT (bucket
, 0);
1338 else if (++index
>= obsize
)
1342 bucket
= XVECTOR (alist
)->contents
[index
];
1347 /* Is this element a possible completion? */
1349 if (STRINGP (eltstring
)
1350 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1351 /* If HIDE_SPACES, reject alternatives that start with space
1352 unless the input starts with space. */
1353 && ((STRING_BYTES (XSTRING (string
)) > 0
1354 && XSTRING (string
)->data
[0] == ' ')
1355 || XSTRING (eltstring
)->data
[0] != ' '
1356 || NILP (hide_spaces
))
1357 && (tem
= Fcompare_strings (eltstring
, make_number (0),
1358 make_number (XSTRING (string
)->size
),
1359 string
, make_number (0),
1360 make_number (XSTRING (string
)->size
),
1361 completion_ignore_case
? Qt
: Qnil
),
1365 Lisp_Object regexps
;
1367 XSETFASTINT (zero
, 0);
1369 /* Ignore this element if it fails to match all the regexps. */
1370 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1371 regexps
= XCDR (regexps
))
1373 tem
= Fstring_match (XCAR (regexps
), eltstring
, zero
);
1377 if (CONSP (regexps
))
1380 /* Ignore this element if there is a predicate
1381 and the predicate doesn't like it. */
1383 if (!NILP (predicate
))
1385 if (EQ (predicate
, Qcommandp
))
1386 tem
= Fcommandp (elt
);
1389 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1390 tem
= call1 (predicate
, elt
);
1393 if (NILP (tem
)) continue;
1395 /* Ok => put it on the list. */
1396 allmatches
= Fcons (eltstring
, allmatches
);
1400 return Fnreverse (allmatches
);
1403 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1404 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1405 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1406 Lisp_Object Vminibuffer_completing_file_name
;
1408 /* This comment supplies the doc string for completing-read,
1409 for make-docfile to see. We cannot put this in the real DEFUN
1410 due to limits in the Unix cpp.
1412 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1413 "Read a string in the minibuffer, with completion.\n\
1414 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1415 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1416 TABLE can also be a function to do the completion itself.\n\
1417 PREDICATE limits completion to a subset of TABLE.\n\
1418 See `try-completion' and `all-completions' for more details\n\
1419 on completion, TABLE, and PREDICATE.\n\
1421 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1422 the input is (or completes to) an element of TABLE or is null.\n\
1423 If it is also not t, Return does not exit if it does non-null completion.\n\
1424 If the input is null, `completing-read' returns an empty string,\n\
1425 regardless of the value of REQUIRE-MATCH.\n\
1427 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1428 If it is (STRING . POSITION), the initial input\n\
1429 is STRING, but point is placed POSITION characters into the string.\n\
1430 HIST, if non-nil, specifies a history list\n\
1431 and optionally the initial position in the list.\n\
1432 It can be a symbol, which is the history list variable to use,\n\
1433 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1434 In that case, HISTVAR is the history list variable to use,\n\
1435 and HISTPOS is the initial position (the position in the list\n\
1436 which INITIAL-INPUT corresponds to).\n\
1437 Positions are counted starting from 1 at the beginning of the list.\n\
1438 DEF, if non-nil, is the default value.\n\
1440 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1441 the current input method and the setting of enable-multibyte-characters.\n\
1443 Completion ignores case if the ambient value of\n\
1444 `completion-ignore-case' is non-nil."
1446 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1447 0 /* See immediately above */)
1448 (prompt
, table
, predicate
, require_match
, initial_input
, hist
, def
, inherit_input_method
)
1449 Lisp_Object prompt
, table
, predicate
, require_match
, initial_input
;
1450 Lisp_Object hist
, def
, inherit_input_method
;
1452 Lisp_Object val
, histvar
, histpos
, position
;
1455 int count
= specpdl_ptr
- specpdl
;
1456 struct gcpro gcpro1
;
1458 init
= initial_input
;
1461 specbind (Qminibuffer_completion_table
, table
);
1462 specbind (Qminibuffer_completion_predicate
, predicate
);
1463 specbind (Qminibuffer_completion_confirm
,
1464 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1465 last_exact_completion
= Qnil
;
1472 position
= Fcdr (init
);
1475 CHECK_STRING (init
, 0);
1476 if (!NILP (position
))
1478 CHECK_NUMBER (position
, 0);
1479 /* Convert to distance from end of input. */
1480 pos
= XINT (position
) - XSTRING (init
)->size
;
1491 histvar
= Fcar_safe (hist
);
1492 histpos
= Fcdr_safe (hist
);
1495 histvar
= Qminibuffer_history
;
1497 XSETFASTINT (histpos
, 0);
1499 val
= read_minibuf (NILP (require_match
)
1500 ? Vminibuffer_local_completion_map
1501 : Vminibuffer_local_must_match_map
,
1502 init
, prompt
, make_number (pos
), 0,
1503 histvar
, histpos
, def
, 0,
1504 !NILP (inherit_input_method
));
1506 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1509 RETURN_UNGCPRO (unbind_to (count
, val
));
1512 Lisp_Object
Fminibuffer_completion_help ();
1513 Lisp_Object
assoc_for_completion ();
1515 /* Test whether TXT is an exact completion. */
1517 test_completion (txt
)
1522 if (CONSP (Vminibuffer_completion_table
)
1523 || NILP (Vminibuffer_completion_table
))
1524 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1525 else if (VECTORP (Vminibuffer_completion_table
))
1527 /* Bypass intern-soft as that loses for nil */
1528 tem
= oblookup (Vminibuffer_completion_table
,
1529 XSTRING (txt
)->data
,
1530 XSTRING (txt
)->size
,
1531 STRING_BYTES (XSTRING (txt
)));
1534 if (STRING_MULTIBYTE (txt
))
1535 txt
= Fstring_make_unibyte (txt
);
1537 txt
= Fstring_make_multibyte (txt
);
1539 tem
= oblookup (Vminibuffer_completion_table
,
1540 XSTRING (txt
)->data
,
1541 XSTRING (txt
)->size
,
1542 STRING_BYTES (XSTRING (txt
)));
1546 if (!NILP (Vminibuffer_completion_predicate
))
1547 return call1 (Vminibuffer_completion_predicate
, tem
);
1552 return call3 (Vminibuffer_completion_table
, txt
,
1553 Vminibuffer_completion_predicate
, Qlambda
);
1557 * 0 no possible completion
1558 * 1 was already an exact and unique completion
1559 * 3 was already an exact completion
1560 * 4 completed to an exact completion
1561 * 5 some completion happened
1562 * 6 no completion happened
1567 Lisp_Object completion
, tem
;
1570 struct gcpro gcpro1
, gcpro2
;
1572 completion
= Ftry_completion (Ffield_string (ZV
),
1573 Vminibuffer_completion_table
,
1574 Vminibuffer_completion_predicate
);
1575 last
= last_exact_completion
;
1576 last_exact_completion
= Qnil
;
1578 GCPRO2 (completion
, last
);
1580 if (NILP (completion
))
1583 temp_echo_area_glyphs (" [No match]");
1588 if (EQ (completion
, Qt
)) /* exact and unique match */
1595 tem
= Fstring_equal (completion
, Ffield_string(ZV
));
1596 completedp
= NILP (tem
);
1599 Fdelete_field (make_number (ZV
)); /* Some completion happened */
1600 Finsert (1, &completion
);
1603 /* It did find a match. Do we match some possibility exactly now? */
1604 tem
= test_completion (Ffield_string(ZV
));
1607 /* not an exact match */
1612 Fminibuffer_completion_help ();
1614 temp_echo_area_glyphs (" [Next char not unique]");
1617 else if (completedp
)
1622 /* If the last exact completion and this one were the same,
1623 it means we've already given a "Complete but not unique"
1624 message and the user's hit TAB again, so now we give him help. */
1625 last_exact_completion
= completion
;
1628 tem
= Ffield_string (ZV
);
1629 if (!NILP (Fequal (tem
, last
)))
1630 Fminibuffer_completion_help ();
1636 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1639 assoc_for_completion (key
, list
)
1640 register Lisp_Object key
;
1643 register Lisp_Object tail
;
1645 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1647 register Lisp_Object elt
, tem
, thiscar
;
1649 if (!CONSP (elt
)) continue;
1650 thiscar
= Fcar (elt
);
1651 if (!STRINGP (thiscar
))
1653 tem
= Fcompare_strings (thiscar
, make_number (0), Qnil
,
1654 key
, make_number (0), Qnil
,
1655 completion_ignore_case
? Qt
: Qnil
);
1663 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1664 "Complete the minibuffer contents as far as possible.\n\
1665 Return nil if there is no valid completion, else t.\n\
1666 If no characters can be completed, display a list of possible completions.\n\
1667 If you repeat this command after it displayed such a list,\n\
1668 scroll the window of possible completions.")
1672 Lisp_Object window
, tem
;
1674 /* If the previous command was not this,
1675 mark the completion buffer obsolete. */
1676 if (! EQ (current_kboard
->Vlast_command
, Vthis_command
))
1677 Vminibuf_scroll_window
= Qnil
;
1679 window
= Vminibuf_scroll_window
;
1680 /* If there's a fresh completion window with a live buffer,
1681 and this command is repeated, scroll that window. */
1682 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1683 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1685 struct buffer
*obuf
= current_buffer
;
1687 Fset_buffer (XWINDOW (window
)->buffer
);
1688 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1690 /* If end is in view, scroll up to the beginning. */
1691 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1693 /* Else scroll down one screen. */
1694 Fscroll_other_window (Qnil
);
1696 set_buffer_internal (obuf
);
1700 i
= do_completion ();
1707 temp_echo_area_glyphs (" [Sole completion]");
1711 temp_echo_area_glyphs (" [Complete, but not unique]");
1718 /* Subroutines of Fminibuffer_complete_and_exit. */
1720 /* This one is called by internal_condition_case to do the real work. */
1723 complete_and_exit_1 ()
1725 return make_number (do_completion ());
1728 /* This one is called by internal_condition_case if an error happens.
1729 Pretend the current value is an exact match. */
1732 complete_and_exit_2 (ignore
)
1735 return make_number (1);
1738 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1739 Sminibuffer_complete_and_exit
, 0, 0, "",
1740 "If the minibuffer contents is a valid completion then exit.\n\
1741 Otherwise try to complete it. If completion leads to a valid completion,\n\
1742 a repetition of this command will exit.")
1748 /* Allow user to specify null string */
1749 if (Ffield_beginning (ZV
, Qnil
) == ZV
)
1752 if (!NILP (test_completion (Ffield_string (ZV
))))
1755 /* Call do_completion, but ignore errors. */
1756 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1757 complete_and_exit_2
);
1767 if (!NILP (Vminibuffer_completion_confirm
))
1769 temp_echo_area_glyphs (" [Confirm]");
1779 Fthrow (Qexit
, Qnil
);
1783 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1785 "Complete the minibuffer contents at most a single word.\n\
1786 After one word is completed as much as possible, a space or hyphen\n\
1787 is added, provided that matches some possible completion.\n\
1788 Return nil if there is no valid completion, else t.")
1791 Lisp_Object completion
, tem
, tem1
;
1792 register int i
, i_byte
;
1793 register unsigned char *completion_string
;
1794 struct gcpro gcpro1
, gcpro2
;
1795 int prompt_end_charpos
;
1797 /* We keep calling Fbuffer_string rather than arrange for GC to
1798 hold onto a pointer to one of the strings thus made. */
1800 completion
= Ftry_completion (Ffield_string (ZV
),
1801 Vminibuffer_completion_table
,
1802 Vminibuffer_completion_predicate
);
1803 if (NILP (completion
))
1806 temp_echo_area_glyphs (" [No match]");
1809 if (EQ (completion
, Qt
))
1812 #if 0 /* How the below code used to look, for reference. */
1813 tem
= Ffield_string (ZV
);
1814 b
= XSTRING (tem
)->data
;
1815 i
= ZV
- 1 - XSTRING (completion
)->size
;
1816 p
= XSTRING (completion
)->data
;
1818 0 <= scmp (b
, p
, ZV
- 1))
1821 /* Set buffer to longest match of buffer tail and completion head. */
1822 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1824 del_range (1, i
+ 1);
1827 #else /* Rewritten code */
1829 int buffer_nchars
, completion_nchars
;
1831 CHECK_STRING (completion
, 0);
1832 tem
= Ffield_string (ZV
);
1833 GCPRO2 (completion
, tem
);
1834 /* If reading a file name,
1835 expand any $ENVVAR refs in the buffer and in TEM. */
1836 if (! NILP (Vminibuffer_completing_file_name
))
1838 Lisp_Object substituted
;
1839 substituted
= Fsubstitute_in_file_name (tem
);
1840 if (! EQ (substituted
, tem
))
1843 Fdelete_field (make_number (ZV
));
1844 insert_from_string (tem
, 0, 0, XSTRING (tem
)->size
,
1845 STRING_BYTES (XSTRING (tem
)), 0);
1848 buffer_nchars
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1849 completion_nchars
= XSTRING (completion
)->size
;
1850 i
= buffer_nchars
- completion_nchars
;
1853 (tem1
= Fcompare_strings (tem
, make_number (0),
1854 make_number (buffer_nchars
),
1855 completion
, make_number (0),
1856 make_number (buffer_nchars
),
1857 completion_ignore_case
? Qt
: Qnil
),
1862 /* Set buffer to longest match of buffer tail and completion head. */
1868 tem1
= Fcompare_strings (tem
, make_number (start_pos
), Qnil
,
1869 completion
, make_number (0),
1870 make_number (buffer_nchars
),
1871 completion_ignore_case
? Qt
: Qnil
);
1878 del_range (1, i
+ 1);
1879 SET_PT_BOTH (ZV
, ZV_BYTE
);
1883 #endif /* Rewritten code */
1885 prompt_end_charpos
= Ffield_beginning (make_number (ZV
), Qnil
);
1888 int prompt_end_bytepos
;
1889 prompt_end_bytepos
= CHAR_TO_BYTE (prompt_end_charpos
);
1890 i
= ZV
- prompt_end_charpos
;
1891 i_byte
= ZV_BYTE
- prompt_end_bytepos
;
1894 /* If completion finds next char not unique,
1895 consider adding a space or a hyphen. */
1896 if (i
== XSTRING (completion
)->size
)
1898 GCPRO1 (completion
);
1899 tem
= Ftry_completion (concat2 (Ffield_string (ZV
), build_string (" ")),
1900 Vminibuffer_completion_table
,
1901 Vminibuffer_completion_predicate
);
1908 GCPRO1 (completion
);
1910 Ftry_completion (concat2 (Ffield_string (ZV
), build_string ("-")),
1911 Vminibuffer_completion_table
,
1912 Vminibuffer_completion_predicate
);
1920 /* Now find first word-break in the stuff found by completion.
1921 i gets index in string of where to stop completing. */
1924 int bytes
= STRING_BYTES (XSTRING (completion
));
1925 completion_string
= XSTRING (completion
)->data
;
1926 for (; i_byte
< STRING_BYTES (XSTRING (completion
)); i_byte
+= len
, i
++)
1928 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i_byte
,
1931 if (SYNTAX (c
) != Sword
)
1940 /* If got no characters, print help for user. */
1942 if (i
== ZV
- prompt_end_charpos
)
1945 Fminibuffer_completion_help ();
1949 /* Otherwise insert in minibuffer the chars we got */
1951 Fdelete_field (make_number (ZV
));
1952 insert_from_string (completion
, 0, 0, i
, i_byte
, 1);
1956 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1958 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1959 Each element may be just a symbol or string\n\
1960 or may be a list of two strings to be printed as if concatenated.\n\
1961 `standard-output' must be a buffer.\n\
1962 The actual completion alternatives, as inserted, are given `mouse-face'\n\
1963 properties of `highlight'.\n\
1964 At the end, this runs the normal hook `completion-setup-hook'.\n\
1965 It can find the completion buffer in `standard-output'.")
1967 Lisp_Object completions
;
1969 Lisp_Object tail
, elt
;
1972 struct gcpro gcpro1
, gcpro2
;
1973 struct buffer
*old
= current_buffer
;
1976 /* Note that (when it matters) every variable
1977 points to a non-string that is pointed to by COMPLETIONS,
1978 except for ELT. ELT can be pointing to a string
1979 when terpri or Findent_to calls a change hook. */
1981 GCPRO2 (completions
, elt
);
1983 if (BUFFERP (Vstandard_output
))
1984 set_buffer_internal (XBUFFER (Vstandard_output
));
1986 if (NILP (completions
))
1987 write_string ("There are no possible completions of what you have typed.",
1991 write_string ("Possible completions are:", -1);
1992 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1994 Lisp_Object tem
, string
;
1996 Lisp_Object startpos
, endpos
;
1999 /* Compute the length of this element. */
2003 CHECK_STRING (tem
, 0);
2004 length
= XSTRING (tem
)->size
;
2006 tem
= Fcar (XCDR (elt
));
2007 CHECK_STRING (tem
, 0);
2008 length
+= XSTRING (tem
)->size
;
2012 CHECK_STRING (elt
, 0);
2013 length
= XSTRING (elt
)->size
;
2016 /* This does a bad job for narrower than usual windows.
2017 Sadly, the window it will appear in is not known
2018 until after the text has been made. */
2020 if (BUFFERP (Vstandard_output
))
2021 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2023 /* If the previous completion was very wide,
2024 or we have two on this line already,
2025 don't put another on the same line. */
2026 if (column
> 33 || first
2027 /* If this is really wide, don't put it second on a line. */
2028 || (column
> 0 && length
> 45))
2033 /* Otherwise advance to column 35. */
2036 if (BUFFERP (Vstandard_output
))
2038 tem
= Findent_to (make_number (35), make_number (2));
2040 column
= XINT (tem
);
2046 write_string (" ", -1);
2049 while (column
< 35);
2053 if (BUFFERP (Vstandard_output
))
2055 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2056 Fset_text_properties (startpos
, endpos
,
2057 Qnil
, Vstandard_output
);
2060 /* Output this element.
2061 If necessary, convert it to unibyte or to multibyte first. */
2063 string
= Fcar (elt
);
2066 if (NILP (current_buffer
->enable_multibyte_characters
)
2067 && STRING_MULTIBYTE (string
))
2068 string
= Fstring_make_unibyte (string
);
2069 else if (!NILP (current_buffer
->enable_multibyte_characters
)
2070 && !STRING_MULTIBYTE (string
))
2071 string
= Fstring_make_multibyte (string
);
2073 if (BUFFERP (Vstandard_output
))
2075 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2077 Fprinc (string
, Qnil
);
2079 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2081 Fput_text_property (startpos
, endpos
,
2082 Qmouse_face
, intern ("highlight"),
2087 Fprinc (string
, Qnil
);
2090 /* Output the annotation for this element. */
2093 if (BUFFERP (Vstandard_output
))
2095 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2097 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2099 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
2101 Fset_text_properties (startpos
, endpos
, Qnil
,
2106 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
2111 /* Update COLUMN for what we have output. */
2114 /* If output is to a buffer, recompute COLUMN in a way
2115 that takes account of character widths. */
2116 if (BUFFERP (Vstandard_output
))
2118 tem
= Fcurrent_column ();
2119 column
= XINT (tem
);
2128 if (BUFFERP (Vstandard_output
))
2129 set_buffer_internal (old
);
2131 if (!NILP (Vrun_hooks
))
2132 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
2137 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
2139 "Display a list of possible completions of the current minibuffer contents.")
2142 Lisp_Object completions
;
2144 message ("Making completion list...");
2145 completions
= Fall_completions (Ffield_string (ZV
),
2146 Vminibuffer_completion_table
,
2147 Vminibuffer_completion_predicate
,
2149 clear_message (1, 0);
2151 if (NILP (completions
))
2154 temp_echo_area_glyphs (" [No completions]");
2157 internal_with_output_to_temp_buffer ("*Completions*",
2158 Fdisplay_completion_list
,
2159 Fsort (completions
, Qstring_lessp
));
2163 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
2164 "Terminate minibuffer input.")
2167 if (INTEGERP (last_command_char
))
2168 internal_self_insert (XINT (last_command_char
), 0);
2172 Fthrow (Qexit
, Qnil
);
2175 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
2176 "Terminate this minibuffer argument.")
2179 Fthrow (Qexit
, Qnil
);
2182 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
2183 "Return current depth of activations of minibuffer, a nonnegative integer.")
2186 return make_number (minibuf_level
);
2189 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
2190 "Return the prompt string of the currently-active minibuffer.\n\
2191 If no minibuffer is active, return nil.")
2194 return Fcopy_sequence (minibuf_prompt
);
2198 /* Temporarily display the string M at the end of the current
2199 minibuffer contents. This is used to display things like
2200 "[No Match]" when the user requests a completion for a prefix
2201 that has no possible completions, and other quick, unobtrusive
2205 temp_echo_area_glyphs (m
)
2209 int osize_byte
= ZV_BYTE
;
2211 int opoint_byte
= PT_BYTE
;
2212 Lisp_Object oinhibit
;
2213 oinhibit
= Vinhibit_quit
;
2215 /* Clear out any old echo-area message to make way for our new thing. */
2218 SET_PT_BOTH (osize
, osize_byte
);
2220 SET_PT_BOTH (opoint
, opoint_byte
);
2222 Fsit_for (make_number (2), Qnil
, Qnil
);
2223 del_range_both (osize
, osize_byte
, ZV
, ZV_BYTE
, 1);
2224 SET_PT_BOTH (opoint
, opoint_byte
);
2225 if (!NILP (Vquit_flag
))
2228 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
2230 Vinhibit_quit
= oinhibit
;
2233 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
2235 "Temporarily display STRING at the end of the minibuffer.\n\
2236 The text is displayed for two seconds,\n\
2237 or until the next input event arrives, whichever comes first.")
2241 temp_echo_area_glyphs (XSTRING (string
)->data
);
2246 init_minibuf_once ()
2248 Vminibuffer_list
= Qnil
;
2249 staticpro (&Vminibuffer_list
);
2256 minibuf_prompt
= Qnil
;
2257 staticpro (&minibuf_prompt
);
2259 minibuf_save_list
= Qnil
;
2260 staticpro (&minibuf_save_list
);
2262 Qread_file_name_internal
= intern ("read-file-name-internal");
2263 staticpro (&Qread_file_name_internal
);
2265 Qminibuffer_default
= intern ("minibuffer-default");
2266 staticpro (&Qminibuffer_default
);
2267 Fset (Qminibuffer_default
, Qnil
);
2269 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
2270 staticpro (&Qminibuffer_completion_table
);
2272 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
2273 staticpro (&Qminibuffer_completion_confirm
);
2275 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
2276 staticpro (&Qminibuffer_completion_predicate
);
2278 staticpro (&last_exact_completion
);
2279 last_exact_completion
= Qnil
;
2281 staticpro (&last_minibuf_string
);
2282 last_minibuf_string
= Qnil
;
2284 Quser_variable_p
= intern ("user-variable-p");
2285 staticpro (&Quser_variable_p
);
2287 Qminibuffer_history
= intern ("minibuffer-history");
2288 staticpro (&Qminibuffer_history
);
2290 Qbuffer_name_history
= intern ("buffer-name-history");
2291 staticpro (&Qbuffer_name_history
);
2292 Fset (Qbuffer_name_history
, Qnil
);
2294 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2295 staticpro (&Qminibuffer_setup_hook
);
2297 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2298 staticpro (&Qminibuffer_exit_hook
);
2300 Qhistory_length
= intern ("history-length");
2301 staticpro (&Qhistory_length
);
2303 Qcurrent_input_method
= intern ("current-input-method");
2304 staticpro (&Qcurrent_input_method
);
2306 Qactivate_input_method
= intern ("activate-input-method");
2307 staticpro (&Qactivate_input_method
);
2309 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2310 "If this is non-nil, `read-buffer' does its work by calling this function.");
2311 Vread_buffer_function
= Qnil
;
2313 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2314 "Normal hook run just after entry to minibuffer.");
2315 Vminibuffer_setup_hook
= Qnil
;
2317 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2318 "Normal hook run just after exit from minibuffer.");
2319 Vminibuffer_exit_hook
= Qnil
;
2321 DEFVAR_LISP ("history-length", &Vhistory_length
,
2322 "*Maximum length for history lists before truncation takes place.\n\
2323 A number means that length; t means infinite. Truncation takes place\n\
2324 just after a new element is inserted. Setting the history-length\n\
2325 property of a history variable overrides this default.");
2326 XSETFASTINT (Vhistory_length
, 30);
2328 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
2329 "*Non-nil means automatically provide help for invalid completion input.");
2332 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2333 "Non-nil means don't consider case significant in completion.");
2334 completion_ignore_case
= 0;
2336 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2337 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2338 This variable makes a difference whenever the minibuffer window is active.");
2339 enable_recursive_minibuffers
= 0;
2341 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2342 "Alist or obarray used for completion in the minibuffer.\n\
2343 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2345 The value may alternatively be a function, which is given three arguments:\n\
2346 STRING, the current buffer contents;\n\
2347 PREDICATE, the predicate for filtering possible matches;\n\
2348 CODE, which says what kind of things to do.\n\
2349 CODE can be nil, t or `lambda'.\n\
2350 nil means to return the best completion of STRING, or nil if there is none.\n\
2351 t means to return a list of all possible completions of STRING.\n\
2352 `lambda' means to return t if STRING is a valid completion as it stands.");
2353 Vminibuffer_completion_table
= Qnil
;
2355 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2356 "Within call to `completing-read', this holds the PREDICATE argument.");
2357 Vminibuffer_completion_predicate
= Qnil
;
2359 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2360 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2361 Vminibuffer_completion_confirm
= Qnil
;
2363 DEFVAR_LISP ("minibuffer-completing-file-name",
2364 &Vminibuffer_completing_file_name
,
2365 "Non-nil means completing file names.");
2366 Vminibuffer_completing_file_name
= Qnil
;
2368 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2369 "Value that `help-form' takes on inside the minibuffer.");
2370 Vminibuffer_help_form
= Qnil
;
2372 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2373 "History list symbol to add minibuffer values to.\n\
2374 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2376 (set minibuffer-history-variable\n\
2377 (cons STRING (symbol-value minibuffer-history-variable)))");
2378 XSETFASTINT (Vminibuffer_history_variable
, 0);
2380 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2381 "Current position of redoing in the history list.");
2382 Vminibuffer_history_position
= Qnil
;
2384 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2385 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2386 Some uses of the echo area also raise that frame (since they use it too).");
2387 minibuffer_auto_raise
= 0;
2389 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2390 "List of regexps that should restrict possible completions.");
2391 Vcompletion_regexp_list
= Qnil
;
2393 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2394 &minibuffer_allow_text_properties
,
2395 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2396 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2397 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2398 with completion; they always discard text properties.");
2399 minibuffer_allow_text_properties
= 0;
2401 defsubr (&Sset_minibuffer_window
);
2402 defsubr (&Sread_from_minibuffer
);
2403 defsubr (&Seval_minibuffer
);
2404 defsubr (&Sread_minibuffer
);
2405 defsubr (&Sread_string
);
2406 defsubr (&Sread_command
);
2407 defsubr (&Sread_variable
);
2408 defsubr (&Sread_buffer
);
2409 defsubr (&Sread_no_blanks_input
);
2410 defsubr (&Sminibuffer_depth
);
2411 defsubr (&Sminibuffer_prompt
);
2413 defsubr (&Stry_completion
);
2414 defsubr (&Sall_completions
);
2415 defsubr (&Scompleting_read
);
2416 defsubr (&Sminibuffer_complete
);
2417 defsubr (&Sminibuffer_complete_word
);
2418 defsubr (&Sminibuffer_complete_and_exit
);
2419 defsubr (&Sdisplay_completion_list
);
2420 defsubr (&Sminibuffer_completion_help
);
2422 defsubr (&Sself_insert_and_exit
);
2423 defsubr (&Sexit_minibuffer
);
2425 defsubr (&Sminibuffer_message
);
2431 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2432 "abort-recursive-edit");
2433 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2435 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2438 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2439 "abort-recursive-edit");
2440 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2442 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2445 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2447 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2449 initial_define_key (Vminibuffer_local_ns_map
, '?',
2450 "self-insert-and-exit");
2452 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2453 "abort-recursive-edit");
2454 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2456 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2459 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2460 "minibuffer-complete");
2461 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2462 "minibuffer-complete-word");
2463 initial_define_key (Vminibuffer_local_completion_map
, '?',
2464 "minibuffer-completion-help");
2466 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2467 "abort-recursive-edit");
2468 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2469 "minibuffer-complete-and-exit");
2470 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2471 "minibuffer-complete-and-exit");
2472 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2473 "minibuffer-complete");
2474 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2475 "minibuffer-complete-word");
2476 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2477 "minibuffer-completion-help");