1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997
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. */
28 #include "dispextern.h"
34 #define min(a, b) ((a) < (b) ? (a) : (b))
38 /* List of buffers for use as minibuffers.
39 The first element of the list is used for the outermost minibuffer
40 invocation, the next element is used for a recursive minibuffer
41 invocation, etc. The list is extended at the end as deeper
42 minibuffer recursions are encountered. */
43 Lisp_Object Vminibuffer_list
;
45 /* Data to remember during recursive minibuffer invocations */
46 Lisp_Object minibuf_save_list
;
48 /* Depth in minibuffer invocations. */
51 /* Nonzero means display completion help for invalid input. */
54 /* The maximum length of a minibuffer history. */
55 Lisp_Object Qhistory_length
, Vhistory_length
;
57 /* Fread_minibuffer leaves the input here as a string. */
58 Lisp_Object last_minibuf_string
;
60 /* Nonzero means let functions called when within a minibuffer
61 invoke recursive minibuffers (to read arguments, or whatever) */
62 int enable_recursive_minibuffers
;
64 /* Nonzero means don't ignore text properties
65 in Fread_from_minibuffer. */
66 int minibuffer_allow_text_properties
;
68 /* help-form is bound to this while in the minibuffer. */
70 Lisp_Object Vminibuffer_help_form
;
72 /* Variable which is the history list to add minibuffer values to. */
74 Lisp_Object Vminibuffer_history_variable
;
76 /* Current position in the history list (adjusted by M-n and M-p). */
78 Lisp_Object Vminibuffer_history_position
;
80 Lisp_Object Qminibuffer_history
;
82 Lisp_Object Qread_file_name_internal
;
84 /* Normal hooks for entry to and exit from minibuffer. */
86 Lisp_Object Qminibuffer_setup_hook
, Vminibuffer_setup_hook
;
87 Lisp_Object Qminibuffer_exit_hook
, Vminibuffer_exit_hook
;
89 /* Function to call to read a buffer name. */
90 Lisp_Object Vread_buffer_function
;
92 /* Nonzero means completion ignores case. */
94 int completion_ignore_case
;
96 /* List of regexps that should restrict possible completions. */
98 Lisp_Object Vcompletion_regexp_list
;
100 /* Nonzero means raise the minibuffer frame when the minibuffer
103 int minibuffer_auto_raise
;
105 /* If last completion attempt reported "Complete but not unique"
106 then this is the string completed then; otherwise this is nil. */
108 static Lisp_Object last_exact_completion
;
110 Lisp_Object Quser_variable_p
;
112 Lisp_Object Qminibuffer_default
;
114 /* Non-nil means it is the window for C-M-v to scroll
115 when the minibuffer is selected. */
116 extern Lisp_Object Vminibuf_scroll_window
;
118 extern Lisp_Object Voverriding_local_map
;
120 Lisp_Object Qcurrent_input_method
, Qactivate_input_method
;
123 /* Put minibuf on currently selected frame's minibuffer.
124 We do this whenever the user starts a new minibuffer
125 or when a minibuffer exits. */
128 choose_minibuf_frame ()
130 if (selected_frame
!= 0
131 && !EQ (minibuf_window
, selected_frame
->minibuffer_window
))
133 /* I don't think that any frames may validly have a null minibuffer
135 if (NILP (selected_frame
->minibuffer_window
))
138 Fset_window_buffer (selected_frame
->minibuffer_window
,
139 XWINDOW (minibuf_window
)->buffer
);
140 minibuf_window
= selected_frame
->minibuffer_window
;
143 /* Make sure no other frame has a minibuffer as its selected window,
144 because the text would not be displayed in it, and that would be
145 confusing. Only allow the selected frame to do this,
146 and that only if the minibuffer is active. */
148 Lisp_Object tail
, frame
;
150 FOR_EACH_FRAME (tail
, frame
)
151 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame
))))
152 && !(XFRAME (frame
) == selected_frame
153 && minibuf_level
> 0))
154 Fset_frame_selected_window (frame
, Fframe_first_window (frame
));
159 choose_minibuf_frame_1 (ignore
)
162 choose_minibuf_frame ();
166 DEFUN ("set-minibuffer-window", Fset_minibuffer_window
,
167 Sset_minibuffer_window
, 1, 1, 0,
168 "Specify which minibuffer window to use for the minibuffer.\n\
169 This effects where the minibuffer is displayed if you put text in it\n\
170 without invoking the usual minibuffer commands.")
174 CHECK_WINDOW (window
, 1);
175 if (! MINI_WINDOW_P (XWINDOW (window
)))
176 error ("Window is not a minibuffer window");
178 minibuf_window
= window
;
184 /* Actual minibuffer invocation. */
186 static Lisp_Object
read_minibuf_unwind ();
187 Lisp_Object
get_minibuffer ();
188 static Lisp_Object
read_minibuf ();
190 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
191 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
192 prompting with PROMPT (a string), using history list HISTVAR
193 with initial position HISTPOS. (BACKUP_N should be <= 0.)
195 Normally return the result as a string (the text that was read),
196 but if EXPFLAG is nonzero, read it and return the object read.
197 If HISTVAR is given, save the value read on that history only if it doesn't
198 match the front of that history list exactly. The value is pushed onto
199 the list as the string that was read.
201 DEFALT specifies te default value for the sake of history commands.
203 If ALLOW_PROPS is nonzero, we do not throw away text properties.
205 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
206 current input method. */
209 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
210 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
214 Lisp_Object backup_n
;
219 int inherit_input_method
;
222 int count
= specpdl_ptr
- specpdl
;
223 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
224 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
225 Lisp_Object enable_multibyte
;
227 specbind (Qminibuffer_default
, defalt
);
229 single_kboard_state ();
232 ambient_dir
= current_buffer
->directory
;
234 enable_multibyte
= Qnil
;
236 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
237 store them away before we can GC. Don't need to protect
238 BACKUP_N because we use the value only if it is an integer. */
239 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
241 if (!STRINGP (prompt
))
242 prompt
= build_string ("");
244 if (!enable_recursive_minibuffers
245 && minibuf_level
> 0)
247 if (EQ (selected_window
, minibuf_window
))
248 error ("Command attempted to use minibuffer while in minibuffer");
250 /* If we're in another window, cancel the minibuffer that's active. */
252 build_string ("Command attempted to use minibuffer while in minibuffer"));
255 /* Choose the minibuffer window and frame, and take action on them. */
257 choose_minibuf_frame ();
259 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
261 record_unwind_protect (Fset_window_configuration
,
262 Fcurrent_window_configuration (Qnil
));
264 /* If the minibuffer window is on a different frame, save that
265 frame's configuration too. */
266 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
267 if (XFRAME (mini_frame
) != selected_frame
)
268 record_unwind_protect (Fset_window_configuration
,
269 Fcurrent_window_configuration (mini_frame
));
271 /* If the minibuffer is on an iconified or invisible frame,
272 make it visible now. */
273 Fmake_frame_visible (mini_frame
);
275 if (minibuffer_auto_raise
)
276 Fraise_frame (mini_frame
);
278 /* We have to do this after saving the window configuration
279 since that is what restores the current buffer. */
281 /* Arrange to restore a number of minibuffer-related variables.
282 We could bind each variable separately, but that would use lots of
285 = Fcons (Voverriding_local_map
,
286 Fcons (minibuf_window
, minibuf_save_list
));
288 = Fcons (minibuf_prompt
,
289 Fcons (make_number (minibuf_prompt_width
),
291 Fcons (Vcurrent_prefix_arg
,
292 Fcons (Vminibuffer_history_position
,
293 Fcons (Vminibuffer_history_variable
,
294 minibuf_save_list
))))));
296 record_unwind_protect (read_minibuf_unwind
, Qnil
);
299 /* Now that we can restore all those variables, start changing them. */
301 minibuf_prompt_width
= 0; /* xdisp.c puts in the right value. */
302 minibuf_prompt
= Fcopy_sequence (prompt
);
303 Vminibuffer_history_position
= histpos
;
304 Vminibuffer_history_variable
= histvar
;
305 Vhelp_form
= Vminibuffer_help_form
;
307 if (inherit_input_method
)
309 /* `current-input-method' is buffer local. So, remeber it in
310 INPUT_METHOD before changing the current buffer. */
311 input_method
= Fsymbol_value (Qcurrent_input_method
);
312 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
315 /* Switch to the minibuffer. */
317 minibuffer
= get_minibuffer (minibuf_level
);
318 Fset_buffer (minibuffer
);
320 /* The current buffer's default directory is usually the right thing
321 for our minibuffer here. However, if you're typing a command at
322 a minibuffer-only frame when minibuf_level is zero, then buf IS
323 the current_buffer, so reset_buffer leaves buf's default
324 directory unchanged. This is a bummer when you've just started
325 up Emacs and buf's default directory is Qnil. Here's a hack; can
326 you think of something better to do? Find another buffer with a
327 better directory, and use that one instead. */
328 if (STRINGP (ambient_dir
))
329 current_buffer
->directory
= ambient_dir
;
332 Lisp_Object buf_list
;
334 for (buf_list
= Vbuffer_alist
;
336 buf_list
= XCONS (buf_list
)->cdr
)
338 Lisp_Object other_buf
;
340 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
341 if (STRINGP (XBUFFER (other_buf
)->directory
))
343 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
349 if (XFRAME (mini_frame
) != selected_frame
)
350 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
352 Vminibuf_scroll_window
= selected_window
;
353 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
354 Fselect_window (minibuf_window
);
355 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
357 Fmake_local_variable (Qprint_escape_newlines
);
358 print_escape_newlines
= 1;
360 /* Erase the buffer. */
362 int count1
= specpdl_ptr
- specpdl
;
363 specbind (Qinhibit_read_only
, Qt
);
365 unbind_to (count1
, Qnil
);
368 /* Put in the initial input. */
371 Finsert (1, &initial
);
372 if (INTEGERP (backup_n
))
373 Fforward_char (backup_n
);
376 echo_area_glyphs
= 0;
377 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
378 previous_echo_glyphs
= 0;
380 current_buffer
->keymap
= map
;
382 /* Turn on an input method stored in INPUT_METHOD if any. */
383 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
384 call1 (Qactivate_input_method
, input_method
);
386 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
387 if (inherit_input_method
)
388 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
390 /* Run our hook, but not if it is empty.
391 (run-hooks would do nothing if it is empty,
392 but it's important to save time here in the usual case). */
393 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
394 && !NILP (Vrun_hooks
))
395 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
397 /* ??? MCC did redraw_screen here if switching screens. */
400 /* If cursor is on the minibuffer line,
401 show the user we have exited by putting it in column 0. */
402 if ((FRAME_CURSOR_Y (selected_frame
)
403 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
406 FRAME_CURSOR_X (selected_frame
)
407 = FRAME_LEFT_SCROLL_BAR_WIDTH (selected_frame
);
408 update_frame (selected_frame
, 1, 1);
411 /* Make minibuffer contents into a string. */
412 Fset_buffer (minibuffer
);
413 val
= make_buffer_string (1, Z
, allow_props
);
414 #if 0 /* make_buffer_string should handle the gap. */
415 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
418 /* VAL is the string of minibuffer text. */
420 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (defalt
))
423 last_minibuf_string
= val
;
425 /* Add the value to the appropriate history list unless it is empty. */
426 if (XSTRING (val
)->size
!= 0
427 && SYMBOLP (Vminibuffer_history_variable
)
428 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
430 /* If the caller wanted to save the value read on a history list,
431 then do so if the value is not already the front of the list. */
433 histval
= Fsymbol_value (Vminibuffer_history_variable
);
435 /* The value of the history variable must be a cons or nil. Other
436 values are unacceptable. We silently ignore these values. */
439 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
443 histval
= Fcons (last_minibuf_string
, histval
);
444 Fset (Vminibuffer_history_variable
, histval
);
446 /* Truncate if requested. */
447 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
448 if (NILP (length
)) length
= Vhistory_length
;
449 if (INTEGERP (length
))
451 if (XINT (length
) <= 0)
452 Fset (Vminibuffer_history_variable
, Qnil
);
457 temp
= Fnthcdr (Fsub1 (length
), histval
);
458 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
464 /* If Lisp form desired instead of string, parse it. */
467 Lisp_Object expr_and_pos
;
470 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
471 /* Ignore trailing whitespace; any other trailing junk is an error. */
472 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
473 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
474 error ("Trailing garbage following expression");
475 val
= Fcar (expr_and_pos
);
478 /* The appropriate frame will get selected
479 in set-window-configuration. */
480 RETURN_UNGCPRO (unbind_to (count
, val
));
483 /* Return a buffer to be used as the minibuffer at depth `depth'.
484 depth = 0 is the lowest allowed argument, and that is the value
485 used for nonrecursive minibuffer invocations */
488 get_minibuffer (depth
)
491 Lisp_Object tail
, num
, buf
;
493 extern Lisp_Object
nconc2 ();
495 XSETFASTINT (num
, depth
);
496 tail
= Fnthcdr (num
, Vminibuffer_list
);
499 tail
= Fcons (Qnil
, Qnil
);
500 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
503 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
505 sprintf (name
, " *Minibuf-%d*", depth
);
506 buf
= Fget_buffer_create (build_string (name
));
508 /* Although the buffer's name starts with a space, undo should be
510 Fbuffer_enable_undo (buf
);
512 XCONS (tail
)->car
= buf
;
516 int count
= specpdl_ptr
- specpdl
;
518 reset_buffer (XBUFFER (buf
));
519 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
521 Fkill_all_local_variables ();
522 unbind_to (count
, Qnil
);
528 /* This function is called on exiting minibuffer, whether normally or not,
529 and it restores the current window, buffer, etc. */
532 read_minibuf_unwind (data
)
535 Lisp_Object old_deactivate_mark
;
538 /* We are exiting the minibuffer one way or the other,
540 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
541 && !NILP (Vrun_hooks
))
542 safe_run_hooks (Qminibuffer_exit_hook
);
544 /* If this was a recursive minibuffer,
545 tie the minibuffer window back to the outer level minibuffer buffer. */
548 window
= minibuf_window
;
549 /* To keep things predictable, in case it matters, let's be in the minibuffer
550 when we reset the relevant variables. */
551 Fset_buffer (XWINDOW (window
)->buffer
);
553 /* Restore prompt, etc, from outer minibuffer level. */
554 minibuf_prompt
= Fcar (minibuf_save_list
);
555 minibuf_save_list
= Fcdr (minibuf_save_list
);
556 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
557 minibuf_save_list
= Fcdr (minibuf_save_list
);
558 Vhelp_form
= Fcar (minibuf_save_list
);
559 minibuf_save_list
= Fcdr (minibuf_save_list
);
560 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
561 minibuf_save_list
= Fcdr (minibuf_save_list
);
562 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
563 minibuf_save_list
= Fcdr (minibuf_save_list
);
564 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
565 minibuf_save_list
= Fcdr (minibuf_save_list
);
566 Voverriding_local_map
= Fcar (minibuf_save_list
);
567 minibuf_save_list
= Fcdr (minibuf_save_list
);
569 temp
= Fcar (minibuf_save_list
);
570 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
571 minibuf_window
= temp
;
573 minibuf_save_list
= Fcdr (minibuf_save_list
);
575 /* Erase the minibuffer we were using at this level. */
577 int count
= specpdl_ptr
- specpdl
;
578 /* Prevent error in erase-buffer. */
579 specbind (Qinhibit_read_only
, Qt
);
580 old_deactivate_mark
= Vdeactivate_mark
;
582 Vdeactivate_mark
= old_deactivate_mark
;
583 unbind_to (count
, Qnil
);
586 /* Make sure minibuffer window is erased, not ignored. */
587 windows_or_buffers_changed
++;
588 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
589 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
595 /* This comment supplies the doc string for read-from-minibuffer,
596 for make-docfile to see. We cannot put this in the real DEFUN
597 due to limits in the Unix cpp.
599 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
600 "Read a string from the minibuffer, prompting with string PROMPT.\n\
601 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
602 to be inserted into the minibuffer before reading input.\n\
603 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
604 is STRING, but point is placed at position POSITION in the minibuffer.\n\
605 Third arg KEYMAP is a keymap to use whilst reading;\n\
606 if omitted or nil, the default is `minibuffer-local-map'.\n\
607 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
608 and return that object:\n\
609 in other words, do `(car (read-from-string INPUT-STRING))'\n\
610 Fifth arg HIST, if non-nil, specifies a history list\n\
611 and optionally the initial position in the list.\n\
612 It can be a symbol, which is the history list variable to use,\n\
613 or it can be a cons cell (HISTVAR . HISTPOS).\n\
614 In that case, HISTVAR is the history list variable to use,\n\
615 and HISTPOS is the initial position (the position in the list\n\
616 which INITIAL-CONTENTS corresponds to).\n\
617 Positions are counted starting from 1 at the beginning of the list.\n\
618 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
619 for history commands, and as the value to return if the user enters\n\
621 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
622 the current input method and the setting of enable-multibyte-characters.\n\
623 If the variable `minibuffer-allow-text-properties is non-nil,\n\
624 then the string which is returned includes whatever text properties\n\
625 were present in the minibuffer. Otherwise the value has no text properties.")
626 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
629 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
630 0 /* See immediately above */)
631 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
632 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
633 Lisp_Object inherit_input_method
;
636 Lisp_Object histvar
, histpos
, position
, val
;
641 CHECK_STRING (prompt
, 0);
642 if (!NILP (initial_contents
))
644 if (CONSP (initial_contents
))
646 position
= Fcdr (initial_contents
);
647 initial_contents
= Fcar (initial_contents
);
649 CHECK_STRING (initial_contents
, 1);
650 if (!NILP (position
))
652 CHECK_NUMBER (position
, 0);
653 /* Convert to distance from end of input. */
654 if (XINT (position
) < 1)
655 /* A number too small means the beginning of the string. */
656 pos
= - XSTRING (initial_contents
)->size
;
658 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
663 keymap
= Vminibuffer_local_map
;
665 keymap
= get_keymap (keymap
);
674 histvar
= Fcar_safe (hist
);
675 histpos
= Fcdr_safe (hist
);
678 histvar
= Qminibuffer_history
;
680 XSETFASTINT (histpos
, 0);
682 GCPRO1 (default_value
);
683 val
= read_minibuf (keymap
, initial_contents
, prompt
,
684 make_number (pos
), !NILP (read
),
685 histvar
, histpos
, default_value
,
686 minibuffer_allow_text_properties
,
687 !NILP (inherit_input_method
));
692 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
693 "Return a Lisp object read using the minibuffer.\n\
694 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
695 is a string to insert in the minibuffer before reading.")
696 (prompt
, initial_contents
)
697 Lisp_Object prompt
, initial_contents
;
699 CHECK_STRING (prompt
, 0);
700 if (!NILP (initial_contents
))
701 CHECK_STRING (initial_contents
, 1);
702 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
703 prompt
, Qnil
, 1, Qminibuffer_history
,
704 make_number (0), Qnil
, 0, 0);
707 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
708 "Return value of Lisp expression read using the minibuffer.\n\
709 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
710 is a string to insert in the minibuffer before reading.")
711 (prompt
, initial_contents
)
712 Lisp_Object prompt
, initial_contents
;
714 return Feval (Fread_minibuffer (prompt
, initial_contents
));
717 /* Functions that use the minibuffer to read various things. */
719 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
720 "Read a string from the minibuffer, prompting with string PROMPT.\n\
721 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
722 The third arg HISTORY, if non-nil, specifies a history list\n\
723 and optionally the initial position in the list.\n\
724 See `read-from-minibuffer' for details of HISTORY argument.\n\
725 Fourth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
726 the current input method and the setting of enable-multibyte-characters.")
727 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
728 Lisp_Object prompt
, initial_input
, history
, default_value
;
729 Lisp_Object inherit_input_method
;
731 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
732 Qnil
, history
, default_value
,
733 inherit_input_method
);
736 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
737 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
738 Prompt with PROMPT, and provide INIT as an initial value of the input string.\n\
739 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
740 the current input method and the setting of enable-multibyte-characters.")
741 (prompt
, init
, inherit_input_method
)
742 Lisp_Object prompt
, init
, inherit_input_method
;
744 CHECK_STRING (prompt
, 0);
746 CHECK_STRING (init
, 1);
748 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
,
749 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
750 !NILP (inherit_input_method
));
753 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
754 "Read the name of a command and return as a symbol.\n\
755 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
756 (prompt
, default_value
)
757 Lisp_Object prompt
, default_value
;
759 Lisp_Object name
, default_string
;
761 if (NILP (default_value
))
762 default_string
= Qnil
;
763 else if (SYMBOLP (default_value
))
764 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
766 default_string
= default_value
;
768 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
769 Qnil
, Qnil
, default_string
, Qnil
);
772 return Fintern (name
, Qnil
);
776 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
777 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
778 Prompts with PROMPT.")
782 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
787 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
788 "Read the name of a user variable and return it as a symbol.\n\
789 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
790 A user variable is one whose documentation starts with a `*' character.")
791 (prompt
, default_value
)
792 Lisp_Object prompt
, default_value
;
794 Lisp_Object name
, default_string
;
796 if (NILP (default_value
))
797 default_string
= Qnil
;
798 else if (SYMBOLP (default_value
))
799 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
801 default_string
= default_value
;
803 name
= Fcompleting_read (prompt
, Vobarray
,
804 Quser_variable_p
, Qt
,
805 Qnil
, Qnil
, default_string
, Qnil
);
808 return Fintern (name
, Qnil
);
811 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
812 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
813 Prompts with PROMPT.\n\
814 Optional second arg DEF is value to return if user enters an empty line.\n\
815 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
816 (prompt
, def
, require_match
)
817 Lisp_Object prompt
, def
, require_match
;
823 def
= XBUFFER (def
)->name
;
825 if (NILP (Vread_buffer_function
))
829 args
[0] = build_string ("%s(default %s) ");
832 prompt
= Fformat (3, args
);
835 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
836 require_match
, Qnil
, Qnil
, def
, Qnil
);
840 args
[0] = Vread_buffer_function
;
843 args
[3] = require_match
;
844 return Ffuncall(4, args
);
848 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
849 "Return common substring of all completions of STRING in ALIST.\n\
850 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
851 All that match are compared together; the longest initial sequence\n\
852 common to all matches is returned as a string.\n\
853 If there is no match at all, nil is returned.\n\
854 For an exact match, t is returned.\n\
856 ALIST can be an obarray instead of an alist.\n\
857 Then the print names of all symbols in the obarray are the possible matches.\n\
859 ALIST can also be a function to do the completion itself.\n\
860 It receives three arguments: the values STRING, PREDICATE and nil.\n\
861 Whatever it returns becomes the value of `try-completion'.\n\
863 If optional third argument PREDICATE is non-nil,\n\
864 it is used to test each possible match.\n\
865 The match is a candidate only if PREDICATE returns non-nil.\n\
866 The argument given to PREDICATE is the alist element\n\
867 or the symbol from the obarray.")
868 (string
, alist
, predicate
)
869 Lisp_Object string
, alist
, predicate
;
871 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
873 int compare
, matchsize
;
874 int list
= CONSP (alist
) || NILP (alist
);
877 Lisp_Object bucket
, zero
, end
, tem
;
878 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
880 CHECK_STRING (string
, 0);
881 if (!list
&& !VECTORP (alist
))
882 return call3 (alist
, string
, predicate
, Qnil
);
886 /* If ALIST is not a list, set TAIL just for gc pro. */
891 obsize
= XVECTOR (alist
)->size
;
892 bucket
= XVECTOR (alist
)->contents
[index
];
897 /* Get the next element of the alist or obarray. */
898 /* Exit the loop if the elements are all used up. */
899 /* elt gets the alist element or symbol.
900 eltstring gets the name to check as a completion. */
907 eltstring
= Fcar (elt
);
912 if (XFASTINT (bucket
) != 0)
915 eltstring
= Fsymbol_name (elt
);
916 if (XSYMBOL (bucket
)->next
)
917 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
919 XSETFASTINT (bucket
, 0);
921 else if (++index
>= obsize
)
925 bucket
= XVECTOR (alist
)->contents
[index
];
930 /* Is this element a possible completion? */
932 if (STRINGP (eltstring
)
933 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
934 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
935 XSTRING (string
)->size
))
940 XSETFASTINT (zero
, 0);
942 /* Ignore this element if it fails to match all the regexps. */
943 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
944 regexps
= XCONS (regexps
)->cdr
)
946 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
953 /* Ignore this element if there is a predicate
954 and the predicate doesn't like it. */
956 if (!NILP (predicate
))
958 if (EQ (predicate
, Qcommandp
))
959 tem
= Fcommandp (elt
);
962 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
963 tem
= call1 (predicate
, elt
);
966 if (NILP (tem
)) continue;
969 /* Update computation of how much all possible completions match */
972 if (NILP (bestmatch
))
973 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
976 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
977 matchsize
= scmp (XSTRING (bestmatch
)->data
,
978 XSTRING (eltstring
)->data
,
982 if (completion_ignore_case
)
984 /* If this is an exact match except for case,
985 use it as the best match rather than one that is not an
986 exact match. This way, we get the case pattern
987 of the actual match. */
988 if ((matchsize
== XSTRING (eltstring
)->size
989 && matchsize
< XSTRING (bestmatch
)->size
)
991 /* If there is more than one exact match ignoring case,
992 and one of them is exact including case,
994 /* If there is no exact match ignoring case,
995 prefer a match that does not change the case
997 ((matchsize
== XSTRING (eltstring
)->size
)
999 (matchsize
== XSTRING (bestmatch
)->size
)
1000 && !bcmp (XSTRING (eltstring
)->data
,
1001 XSTRING (string
)->data
, XSTRING (string
)->size
)
1002 && bcmp (XSTRING (bestmatch
)->data
,
1003 XSTRING (string
)->data
, XSTRING (string
)->size
)))
1004 bestmatch
= eltstring
;
1006 bestmatchsize
= matchsize
;
1011 if (NILP (bestmatch
))
1012 return Qnil
; /* No completions found */
1013 /* If we are ignoring case, and there is no exact match,
1014 and no additional text was supplied,
1015 don't change the case of what the user typed. */
1016 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
1017 && XSTRING (bestmatch
)->size
> bestmatchsize
)
1020 /* Return t if the supplied string is an exact match (counting case);
1021 it does not require any change to be made. */
1022 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
1023 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
1027 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1028 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1029 return Fsubstring (bestmatch
, zero
, end
);
1032 /* Compare exactly LEN chars of strings at S1 and S2,
1033 ignoring case if appropriate.
1034 Return -1 if strings match,
1035 else number of chars that match at the beginning. */
1039 register unsigned char *s1
, *s2
;
1042 register int l
= len
;
1043 register unsigned char *start
= s1
;
1045 if (completion_ignore_case
)
1047 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1052 while (l
&& *s1
++ == *s2
++)
1059 int match
= len
- l
;
1061 /* Now *--S1 is the unmatching byte. If it is in the middle of
1062 multi-byte form, we must say that the multi-byte character
1063 there doesn't match. */
1064 while (match
&& *--s1
>= 0xA0) match
--;
1069 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1070 "Search for partial matches to STRING in ALIST.\n\
1071 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1072 The value is a list of all the strings from ALIST that match.\n\
1074 ALIST can be an obarray instead of an alist.\n\
1075 Then the print names of all symbols in the obarray are the possible matches.\n\
1077 ALIST can also be a function to do the completion itself.\n\
1078 It receives three arguments: the values STRING, PREDICATE and t.\n\
1079 Whatever it returns becomes the value of `all-completion'.\n\
1081 If optional third argument PREDICATE is non-nil,\n\
1082 it is used to test each possible match.\n\
1083 The match is a candidate only if PREDICATE returns non-nil.\n\
1084 The argument given to PREDICATE is the alist element\n\
1085 or the symbol from the obarray.\n\
1087 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1088 strings in ALIST that start with a space\n\
1089 are ignored unless STRING itself starts with a space.")
1090 (string
, alist
, predicate
, hide_spaces
)
1091 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1093 Lisp_Object tail
, elt
, eltstring
;
1094 Lisp_Object allmatches
;
1095 int list
= CONSP (alist
) || NILP (alist
);
1097 Lisp_Object bucket
, tem
;
1098 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1100 CHECK_STRING (string
, 0);
1101 if (!list
&& !VECTORP (alist
))
1103 return call3 (alist
, string
, predicate
, Qt
);
1107 /* If ALIST is not a list, set TAIL just for gc pro. */
1112 obsize
= XVECTOR (alist
)->size
;
1113 bucket
= XVECTOR (alist
)->contents
[index
];
1118 /* Get the next element of the alist or obarray. */
1119 /* Exit the loop if the elements are all used up. */
1120 /* elt gets the alist element or symbol.
1121 eltstring gets the name to check as a completion. */
1128 eltstring
= Fcar (elt
);
1133 if (XFASTINT (bucket
) != 0)
1136 eltstring
= Fsymbol_name (elt
);
1137 if (XSYMBOL (bucket
)->next
)
1138 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1140 XSETFASTINT (bucket
, 0);
1142 else if (++index
>= obsize
)
1146 bucket
= XVECTOR (alist
)->contents
[index
];
1151 /* Is this element a possible completion? */
1153 if (STRINGP (eltstring
)
1154 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1155 /* If HIDE_SPACES, reject alternatives that start with space
1156 unless the input starts with space. */
1157 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
1158 || XSTRING (eltstring
)->data
[0] != ' '
1159 || NILP (hide_spaces
))
1160 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1161 XSTRING (string
)->size
))
1164 Lisp_Object regexps
;
1166 XSETFASTINT (zero
, 0);
1168 /* Ignore this element if it fails to match all the regexps. */
1169 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1170 regexps
= XCONS (regexps
)->cdr
)
1172 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1176 if (CONSP (regexps
))
1179 /* Ignore this element if there is a predicate
1180 and the predicate doesn't like it. */
1182 if (!NILP (predicate
))
1184 if (EQ (predicate
, Qcommandp
))
1185 tem
= Fcommandp (elt
);
1188 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1189 tem
= call1 (predicate
, elt
);
1192 if (NILP (tem
)) continue;
1194 /* Ok => put it on the list. */
1195 allmatches
= Fcons (eltstring
, allmatches
);
1199 return Fnreverse (allmatches
);
1202 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1203 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1204 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1206 /* This comment supplies the doc string for completing-read,
1207 for make-docfile to see. We cannot put this in the real DEFUN
1208 due to limits in the Unix cpp.
1210 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1211 "Read a string in the minibuffer, with completion.\n\
1212 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1213 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1214 PREDICATE limits completion to a subset of TABLE.\n\
1215 See `try-completion' and `all-completions' for more details
1216 on completion, TABLE, and PREDICATE.\n\
1218 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1219 the input is (or completes to) an element of TABLE or is null.\n\
1220 If it is also not t, Return does not exit if it does non-null completion.\n\
1221 If the input is null, `completing-read' returns an empty string,\n\
1222 regardless of the value of REQUIRE-MATCH.\n\
1224 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1225 If it is (STRING . POSITION), the initial input\n\
1226 is STRING, but point is placed POSITION characters into the string.\n\
1227 HIST, if non-nil, specifies a history list\n\
1228 and optionally the initial position in the list.\n\
1229 It can be a symbol, which is the history list variable to use,\n\
1230 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1231 In that case, HISTVAR is the history list variable to use,\n\
1232 and HISTPOS is the initial position (the position in the list\n\
1233 which INITIAL-CONTENTS corresponds to).\n\
1234 Positions are counted starting from 1 at the beginning of the list.\n\
1235 DEF, if non-nil, is the default value.\n\
1237 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1238 the current input method and the setting of enable-multibyte-characters.\n\
1240 Completion ignores case if the ambient value of\n\
1241 `completion-ignore-case' is non-nil."
1243 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1244 0 /* See immediately above */)
1245 (prompt
, table
, predicate
, require_match
, init
, hist
, def
, inherit_input_method
)
1246 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
, def
;
1247 Lisp_Object inherit_input_method
;
1249 Lisp_Object val
, histvar
, histpos
, position
;
1251 int count
= specpdl_ptr
- specpdl
;
1252 struct gcpro gcpro1
;
1253 int disable_multibyte
= EQ (table
, Qread_file_name_internal
);
1257 specbind (Qminibuffer_completion_table
, table
);
1258 specbind (Qminibuffer_completion_predicate
, predicate
);
1259 specbind (Qminibuffer_completion_confirm
,
1260 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1261 last_exact_completion
= Qnil
;
1268 position
= Fcdr (init
);
1271 CHECK_STRING (init
, 0);
1272 if (!NILP (position
))
1274 CHECK_NUMBER (position
, 0);
1275 /* Convert to distance from end of input. */
1276 pos
= XINT (position
) - XSTRING (init
)->size
;
1287 histvar
= Fcar_safe (hist
);
1288 histpos
= Fcdr_safe (hist
);
1291 histvar
= Qminibuffer_history
;
1293 XSETFASTINT (histpos
, 0);
1295 val
= read_minibuf (NILP (require_match
)
1296 ? Vminibuffer_local_completion_map
1297 : Vminibuffer_local_must_match_map
,
1298 init
, prompt
, make_number (pos
), 0,
1299 histvar
, histpos
, def
, 0,
1300 !NILP (inherit_input_method
));
1301 RETURN_UNGCPRO (unbind_to (count
, val
));
1304 Lisp_Object
Fminibuffer_completion_help ();
1305 Lisp_Object
assoc_for_completion ();
1306 /* A subroutine of Fintern_soft. */
1307 extern Lisp_Object
oblookup ();
1310 /* Test whether TXT is an exact completion. */
1312 test_completion (txt
)
1317 if (CONSP (Vminibuffer_completion_table
)
1318 || NILP (Vminibuffer_completion_table
))
1319 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1320 else if (VECTORP (Vminibuffer_completion_table
))
1322 /* Bypass intern-soft as that loses for nil */
1323 tem
= oblookup (Vminibuffer_completion_table
,
1324 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1327 else if (!NILP (Vminibuffer_completion_predicate
))
1328 return call1 (Vminibuffer_completion_predicate
, tem
);
1333 return call3 (Vminibuffer_completion_table
, txt
,
1334 Vminibuffer_completion_predicate
, Qlambda
);
1338 * 0 no possible completion
1339 * 1 was already an exact and unique completion
1340 * 3 was already an exact completion
1341 * 4 completed to an exact completion
1342 * 5 some completion happened
1343 * 6 no completion happened
1348 Lisp_Object completion
, tem
;
1351 struct gcpro gcpro1
, gcpro2
;
1353 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1354 Vminibuffer_completion_predicate
);
1355 last
= last_exact_completion
;
1356 last_exact_completion
= Qnil
;
1358 GCPRO2 (completion
, last
);
1360 if (NILP (completion
))
1363 temp_echo_area_glyphs (" [No match]");
1368 if (EQ (completion
, Qt
)) /* exact and unique match */
1375 tem
= Fstring_equal (completion
, Fbuffer_string());
1376 if (completedp
= NILP (tem
))
1378 Ferase_buffer (); /* Some completion happened */
1379 Finsert (1, &completion
);
1382 /* It did find a match. Do we match some possibility exactly now? */
1383 tem
= test_completion (Fbuffer_string ());
1386 /* not an exact match */
1391 Fminibuffer_completion_help ();
1393 temp_echo_area_glyphs (" [Next char not unique]");
1396 else if (completedp
)
1401 /* If the last exact completion and this one were the same,
1402 it means we've already given a "Complete but not unique"
1403 message and the user's hit TAB again, so now we give him help. */
1404 last_exact_completion
= completion
;
1407 tem
= Fbuffer_string ();
1408 if (!NILP (Fequal (tem
, last
)))
1409 Fminibuffer_completion_help ();
1415 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1418 assoc_for_completion (key
, list
)
1419 register Lisp_Object key
;
1422 register Lisp_Object tail
;
1424 if (completion_ignore_case
)
1425 key
= Fupcase (key
);
1427 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1429 register Lisp_Object elt
, tem
, thiscar
;
1431 if (!CONSP (elt
)) continue;
1432 thiscar
= Fcar (elt
);
1433 if (!STRINGP (thiscar
))
1435 if (completion_ignore_case
)
1436 thiscar
= Fupcase (thiscar
);
1437 tem
= Fequal (thiscar
, key
);
1438 if (!NILP (tem
)) return elt
;
1444 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1445 "Complete the minibuffer contents as far as possible.\n\
1446 Return nil if there is no valid completion, else t.\n\
1447 If no characters can be completed, display a list of possible completions.\n\
1448 If you repeat this command after it displayed such a list,\n\
1449 scroll the window of possible completions.")
1453 Lisp_Object window
, tem
;
1455 /* If the previous command was not this, then mark the completion
1457 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1458 Vminibuf_scroll_window
= Qnil
;
1460 window
= Vminibuf_scroll_window
;
1461 /* If there's a fresh completion window with a live buffer,
1462 and this command is repeated, scroll that window. */
1463 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1464 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1466 struct buffer
*obuf
= current_buffer
;
1468 Fset_buffer (XWINDOW (window
)->buffer
);
1469 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1471 /* If end is in view, scroll up to the beginning. */
1472 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1474 /* Else scroll down one screen. */
1475 Fscroll_other_window (Qnil
);
1477 set_buffer_internal (obuf
);
1481 i
= do_completion ();
1488 temp_echo_area_glyphs (" [Sole completion]");
1492 temp_echo_area_glyphs (" [Complete, but not unique]");
1499 /* Subroutines of Fminibuffer_complete_and_exit. */
1501 /* This one is called by internal_condition_case to do the real work. */
1504 complete_and_exit_1 ()
1506 return make_number (do_completion ());
1509 /* This one is called by internal_condition_case if an error happens.
1510 Pretend the current value is an exact match. */
1513 complete_and_exit_2 (ignore
)
1516 return make_number (1);
1519 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1520 Sminibuffer_complete_and_exit
, 0, 0, "",
1521 "If the minibuffer contents is a valid completion then exit.\n\
1522 Otherwise try to complete it. If completion leads to a valid completion,\n\
1523 a repetition of this command will exit.")
1529 /* Allow user to specify null string */
1533 if (!NILP (test_completion (Fbuffer_string ())))
1536 /* Call do_completion, but ignore errors. */
1537 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1538 complete_and_exit_2
);
1548 if (!NILP (Vminibuffer_completion_confirm
))
1550 temp_echo_area_glyphs (" [Confirm]");
1560 Fthrow (Qexit
, Qnil
);
1564 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1566 "Complete the minibuffer contents at most a single word.\n\
1567 After one word is completed as much as possible, a space or hyphen\n\
1568 is added, provided that matches some possible completion.\n\
1569 Return nil if there is no valid completion, else t.")
1572 Lisp_Object completion
, tem
;
1574 register unsigned char *completion_string
;
1575 struct gcpro gcpro1
, gcpro2
;
1577 /* We keep calling Fbuffer_string rather than arrange for GC to
1578 hold onto a pointer to one of the strings thus made. */
1580 completion
= Ftry_completion (Fbuffer_string (),
1581 Vminibuffer_completion_table
,
1582 Vminibuffer_completion_predicate
);
1583 if (NILP (completion
))
1586 temp_echo_area_glyphs (" [No match]");
1589 if (EQ (completion
, Qt
))
1592 #if 0 /* How the below code used to look, for reference. */
1593 tem
= Fbuffer_string ();
1594 b
= XSTRING (tem
)->data
;
1595 i
= ZV
- 1 - XSTRING (completion
)->size
;
1596 p
= XSTRING (completion
)->data
;
1598 0 <= scmp (b
, p
, ZV
- 1))
1601 /* Set buffer to longest match of buffer tail and completion head. */
1602 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1604 del_range (1, i
+ 1);
1607 #else /* Rewritten code */
1609 register unsigned char *buffer_string
;
1610 int buffer_nbytes
, completion_nbytes
;
1612 CHECK_STRING (completion
, 0);
1613 tem
= Fbuffer_string ();
1614 GCPRO2 (completion
, tem
);
1615 /* If reading a file name,
1616 expand any $ENVVAR refs in the buffer and in TEM. */
1617 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1619 Lisp_Object substituted
;
1620 substituted
= Fsubstitute_in_file_name (tem
);
1621 if (! EQ (substituted
, tem
))
1625 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1628 buffer_string
= XSTRING (tem
)->data
;
1629 completion_string
= XSTRING (completion
)->data
;
1630 buffer_nbytes
= XSTRING (tem
)->size
; /* ie ZV_BYTE - BEGV_BYTE */
1631 completion_nbytes
= XSTRING (completion
)->size
;
1632 i
= buffer_nbytes
- completion_nbytes
;
1634 0 <= scmp (buffer_string
, completion_string
, buffer_nbytes
))
1636 /* Set buffer to longest match of buffer tail and completion head. */
1640 while (0 <= scmp (buffer_string
++, completion_string
, buffer_nbytes
--))
1642 del_range_byte (1, i
+ 1, 1);
1643 SET_PT_BOTH (ZV
, ZV_BYTE
);
1647 #endif /* Rewritten code */
1648 i
= ZV_BYTE
- BEGV_BYTE
;
1650 /* If completion finds next char not unique,
1651 consider adding a space or a hyphen. */
1652 if (i
== XSTRING (completion
)->size
)
1654 GCPRO1 (completion
);
1655 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1656 Vminibuffer_completion_table
,
1657 Vminibuffer_completion_predicate
);
1664 GCPRO1 (completion
);
1666 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1667 Vminibuffer_completion_table
,
1668 Vminibuffer_completion_predicate
);
1676 /* Now find first word-break in the stuff found by completion.
1677 i gets index in string of where to stop completing. */
1681 completion_string
= XSTRING (completion
)->data
;
1682 for (; i
< XSTRING (completion
)->size
; i
+= len
)
1684 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i
,
1685 XSTRING (completion
)->size
- i
,
1687 if (SYNTAX (c
) != Sword
)
1695 /* If got no characters, print help for user. */
1697 if (i
== ZV_BYTE
- BEGV_BYTE
)
1700 Fminibuffer_completion_help ();
1704 /* Otherwise insert in minibuffer the chars we got */
1707 insert_from_string (completion
, 0, i
, 1);
1711 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1713 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1714 Each element may be just a symbol or string\n\
1715 or may be a list of two strings to be printed as if concatenated.\n\
1716 `standard-output' must be a buffer.\n\
1717 At the end, run the normal hook `completion-setup-hook'.\n\
1718 It can find the completion buffer in `standard-output'.")
1720 Lisp_Object completions
;
1722 Lisp_Object tail
, elt
;
1725 struct gcpro gcpro1
, gcpro2
;
1726 struct buffer
*old
= current_buffer
;
1729 /* Note that (when it matters) every variable
1730 points to a non-string that is pointed to by COMPLETIONS,
1731 except for ELT. ELT can be pointing to a string
1732 when terpri or Findent_to calls a change hook. */
1734 GCPRO2 (completions
, elt
);
1736 if (BUFFERP (Vstandard_output
))
1737 set_buffer_internal (XBUFFER (Vstandard_output
));
1739 if (NILP (completions
))
1740 write_string ("There are no possible completions of what you have typed.",
1744 write_string ("Possible completions are:", -1);
1745 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1749 Lisp_Object startpos
, endpos
;
1752 /* Compute the length of this element. */
1756 CHECK_STRING (tem
, 0);
1757 length
= XSTRING (tem
)->size
;
1759 tem
= Fcar (XCDR (elt
));
1760 CHECK_STRING (tem
, 0);
1761 length
+= XSTRING (tem
)->size
;
1765 CHECK_STRING (elt
, 0);
1766 length
= XSTRING (elt
)->size
;
1769 /* This does a bad job for narrower than usual windows.
1770 Sadly, the window it will appear in is not known
1771 until after the text has been made. */
1773 if (BUFFERP (Vstandard_output
))
1774 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1776 /* If the previous completion was very wide,
1777 or we have two on this line already,
1778 don't put another on the same line. */
1779 if (column
> 33 || first
1780 /* If this is really wide, don't put it second on a line. */
1781 || column
> 0 && length
> 45)
1786 /* Otherwise advance to column 35. */
1789 if (BUFFERP (Vstandard_output
))
1791 tem
= Findent_to (make_number (35), make_number (2));
1793 column
= XINT (tem
);
1799 write_string (" ", -1);
1802 while (column
< 35);
1806 if (BUFFERP (Vstandard_output
))
1808 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1809 Fset_text_properties (startpos
, endpos
,
1810 Qnil
, Vstandard_output
);
1813 /* Output this element and update COLUMN. */
1816 Fprinc (Fcar (elt
), Qnil
);
1817 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1824 /* If output is to a buffer, recompute COLUMN in a way
1825 that takes account of character widths. */
1826 if (BUFFERP (Vstandard_output
))
1828 tem
= Fcurrent_column ();
1829 column
= XINT (tem
);
1838 if (BUFFERP (Vstandard_output
))
1839 set_buffer_internal (old
);
1841 if (!NILP (Vrun_hooks
))
1842 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1847 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1849 "Display a list of possible completions of the current minibuffer contents.")
1852 Lisp_Object completions
;
1854 message ("Making completion list...");
1855 completions
= Fall_completions (Fbuffer_string (),
1856 Vminibuffer_completion_table
,
1857 Vminibuffer_completion_predicate
,
1859 echo_area_glyphs
= 0;
1861 if (NILP (completions
))
1864 temp_echo_area_glyphs (" [No completions]");
1867 internal_with_output_to_temp_buffer ("*Completions*",
1868 Fdisplay_completion_list
,
1869 Fsort (completions
, Qstring_lessp
));
1873 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1874 "Terminate minibuffer input.")
1877 if (INTEGERP (last_command_char
))
1878 internal_self_insert (last_command_char
, 0);
1882 Fthrow (Qexit
, Qnil
);
1885 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1886 "Terminate this minibuffer argument.")
1889 Fthrow (Qexit
, Qnil
);
1892 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1893 "Return current depth of activations of minibuffer, a nonnegative integer.")
1896 return make_number (minibuf_level
);
1899 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1900 "Return the prompt string of the currently-active minibuffer.\n\
1901 If no minibuffer is active, return nil.")
1904 return Fcopy_sequence (minibuf_prompt
);
1907 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1908 Sminibuffer_prompt_width
, 0, 0, 0,
1909 "Return the display width of the minibuffer prompt.")
1913 XSETFASTINT (width
, minibuf_prompt_width
);
1917 /* Temporarily display the string M at the end of the current
1918 minibuffer contents. This is used to display things like
1919 "[No Match]" when the user requests a completion for a prefix
1920 that has no possible completions, and other quick, unobtrusive
1924 temp_echo_area_glyphs (m
)
1928 int osize_byte
= ZV_BYTE
;
1930 int opoint_byte
= PT_BYTE
;
1931 Lisp_Object oinhibit
;
1932 oinhibit
= Vinhibit_quit
;
1934 /* Clear out any old echo-area message to make way for our new thing. */
1937 SET_PT_BOTH (osize
, osize_byte
);
1939 SET_PT_BOTH (opoint
, opoint_byte
);
1941 Fsit_for (make_number (2), Qnil
, Qnil
);
1942 del_range_both (osize
, ZV
, osize_byte
, ZV_BYTE
, 1);
1943 SET_PT_BOTH (opoint
, opoint_byte
);
1944 if (!NILP (Vquit_flag
))
1947 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1949 Vinhibit_quit
= oinhibit
;
1952 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
1954 "Temporarily display STRING at the end of the minibuffer.\n\
1955 The text is displayed for two seconds,\n\
1956 or until the next input event arrives, whichever comes first.")
1960 temp_echo_area_glyphs (XSTRING (string
)->data
);
1965 init_minibuf_once ()
1967 Vminibuffer_list
= Qnil
;
1968 staticpro (&Vminibuffer_list
);
1975 minibuf_prompt
= Qnil
;
1976 staticpro (&minibuf_prompt
);
1978 minibuf_save_list
= Qnil
;
1979 staticpro (&minibuf_save_list
);
1981 Qread_file_name_internal
= intern ("read-file-name-internal");
1982 staticpro (&Qread_file_name_internal
);
1984 Qminibuffer_default
= intern ("minibuffer-default");
1985 staticpro (&Qminibuffer_default
);
1986 Fset (Qminibuffer_default
, Qnil
);
1988 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1989 staticpro (&Qminibuffer_completion_table
);
1991 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1992 staticpro (&Qminibuffer_completion_confirm
);
1994 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1995 staticpro (&Qminibuffer_completion_predicate
);
1997 staticpro (&last_exact_completion
);
1998 last_exact_completion
= Qnil
;
2000 staticpro (&last_minibuf_string
);
2001 last_minibuf_string
= Qnil
;
2003 Quser_variable_p
= intern ("user-variable-p");
2004 staticpro (&Quser_variable_p
);
2006 Qminibuffer_history
= intern ("minibuffer-history");
2007 staticpro (&Qminibuffer_history
);
2009 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2010 staticpro (&Qminibuffer_setup_hook
);
2012 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2013 staticpro (&Qminibuffer_exit_hook
);
2015 Qhistory_length
= intern ("history-length");
2016 staticpro (&Qhistory_length
);
2018 Qcurrent_input_method
= intern ("current-input-method");
2019 staticpro (&Qcurrent_input_method
);
2021 Qactivate_input_method
= intern ("activate-input-method");
2022 staticpro (&Qactivate_input_method
);
2024 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2025 "If this is non-nil, `read-buffer' does its work by calling this function.");
2026 Vread_buffer_function
= Qnil
;
2028 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2029 "Normal hook run just after entry to minibuffer.");
2030 Vminibuffer_setup_hook
= Qnil
;
2032 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2033 "Normal hook run just after exit from minibuffer.");
2034 Vminibuffer_exit_hook
= Qnil
;
2036 DEFVAR_LISP ("history-length", &Vhistory_length
,
2037 "*Maximum length for history lists before truncation takes place.\n\
2038 A number means that length; t means infinite. Truncation takes place\n\
2039 just after a new element is inserted. Setting the history-length\n\
2040 property of a history variable overrides this default.");
2041 XSETFASTINT (Vhistory_length
, 30);
2043 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
2044 "*Non-nil means automatically provide help for invalid completion input.");
2047 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2048 "Non-nil means don't consider case significant in completion.");
2049 completion_ignore_case
= 0;
2051 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2052 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2053 This variable makes a difference whenever the minibuffer window is active.");
2054 enable_recursive_minibuffers
= 0;
2056 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2057 "Alist or obarray used for completion in the minibuffer.\n\
2058 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2060 The value may alternatively be a function, which is given three arguments:\n\
2061 STRING, the current buffer contents;\n\
2062 PREDICATE, the predicate for filtering possible matches;\n\
2063 CODE, which says what kind of things to do.\n\
2064 CODE can be nil, t or `lambda'.\n\
2065 nil means to return the best completion of STRING, or nil if there is none.\n\
2066 t means to return a list of all possible completions of STRING.\n\
2067 `lambda' means to return t if STRING is a valid completion as it stands.");
2068 Vminibuffer_completion_table
= Qnil
;
2070 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2071 "Within call to `completing-read', this holds the PREDICATE argument.");
2072 Vminibuffer_completion_predicate
= Qnil
;
2074 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2075 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2076 Vminibuffer_completion_confirm
= Qnil
;
2078 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2079 "Value that `help-form' takes on inside the minibuffer.");
2080 Vminibuffer_help_form
= Qnil
;
2082 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2083 "History list symbol to add minibuffer values to.\n\
2084 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2086 (set minibuffer-history-variable\n\
2087 (cons STRING (symbol-value minibuffer-history-variable)))");
2088 XSETFASTINT (Vminibuffer_history_variable
, 0);
2090 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2091 "Current position of redoing in the history list.");
2092 Vminibuffer_history_position
= Qnil
;
2094 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2095 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2096 Some uses of the echo area also raise that frame (since they use it too).");
2097 minibuffer_auto_raise
= 0;
2099 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2100 "List of regexps that should restrict possible completions.");
2101 Vcompletion_regexp_list
= Qnil
;
2103 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2104 &minibuffer_allow_text_properties
,
2105 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2106 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2107 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2108 with completion; they always discard text properties.");
2109 minibuffer_allow_text_properties
= 0;
2111 defsubr (&Sset_minibuffer_window
);
2112 defsubr (&Sread_from_minibuffer
);
2113 defsubr (&Seval_minibuffer
);
2114 defsubr (&Sread_minibuffer
);
2115 defsubr (&Sread_string
);
2116 defsubr (&Sread_command
);
2117 defsubr (&Sread_variable
);
2118 defsubr (&Sread_buffer
);
2119 defsubr (&Sread_no_blanks_input
);
2120 defsubr (&Sminibuffer_depth
);
2121 defsubr (&Sminibuffer_prompt
);
2122 defsubr (&Sminibuffer_prompt_width
);
2124 defsubr (&Stry_completion
);
2125 defsubr (&Sall_completions
);
2126 defsubr (&Scompleting_read
);
2127 defsubr (&Sminibuffer_complete
);
2128 defsubr (&Sminibuffer_complete_word
);
2129 defsubr (&Sminibuffer_complete_and_exit
);
2130 defsubr (&Sdisplay_completion_list
);
2131 defsubr (&Sminibuffer_completion_help
);
2133 defsubr (&Sself_insert_and_exit
);
2134 defsubr (&Sexit_minibuffer
);
2136 defsubr (&Sminibuffer_message
);
2142 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2143 "abort-recursive-edit");
2144 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2146 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2149 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2150 "abort-recursive-edit");
2151 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2153 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2156 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2158 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2160 initial_define_key (Vminibuffer_local_ns_map
, '?',
2161 "self-insert-and-exit");
2163 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2164 "abort-recursive-edit");
2165 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2167 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2170 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2171 "minibuffer-complete");
2172 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2173 "minibuffer-complete-word");
2174 initial_define_key (Vminibuffer_local_completion_map
, '?',
2175 "minibuffer-completion-help");
2177 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2178 "abort-recursive-edit");
2179 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2180 "minibuffer-complete-and-exit");
2181 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2182 "minibuffer-complete-and-exit");
2183 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2184 "minibuffer-complete");
2185 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2186 "minibuffer-complete-word");
2187 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2188 "minibuffer-completion-help");