1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998
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
P_ ((Lisp_Object
));
187 static Lisp_Object read_minibuf
P_ ((Lisp_Object
, Lisp_Object
,
188 Lisp_Object
, Lisp_Object
,
190 Lisp_Object
, Lisp_Object
,
193 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
194 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
195 prompting with PROMPT (a string), using history list HISTVAR
196 with initial position HISTPOS. (BACKUP_N should be <= 0.)
198 Normally return the result as a string (the text that was read),
199 but if EXPFLAG is nonzero, read it and return the object read.
200 If HISTVAR is given, save the value read on that history only if it doesn't
201 match the front of that history list exactly. The value is pushed onto
202 the list as the string that was read.
204 DEFALT specifies te default value for the sake of history commands.
206 If ALLOW_PROPS is nonzero, we do not throw away text properties.
208 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
209 current input method. */
212 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
213 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
217 Lisp_Object backup_n
;
223 int inherit_input_method
;
226 int count
= specpdl_ptr
- specpdl
;
227 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
228 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
229 Lisp_Object enable_multibyte
;
231 specbind (Qminibuffer_default
, defalt
);
233 single_kboard_state ();
236 ambient_dir
= current_buffer
->directory
;
238 enable_multibyte
= Qnil
;
240 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
241 store them away before we can GC. Don't need to protect
242 BACKUP_N because we use the value only if it is an integer. */
243 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
245 if (!STRINGP (prompt
))
246 prompt
= build_string ("");
248 if (!enable_recursive_minibuffers
249 && minibuf_level
> 0)
251 if (EQ (selected_window
, minibuf_window
))
252 error ("Command attempted to use minibuffer while in minibuffer");
254 /* If we're in another window, cancel the minibuffer that's active. */
256 build_string ("Command attempted to use minibuffer while in minibuffer"));
259 /* Choose the minibuffer window and frame, and take action on them. */
261 choose_minibuf_frame ();
263 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
265 record_unwind_protect (Fset_window_configuration
,
266 Fcurrent_window_configuration (Qnil
));
268 /* If the minibuffer window is on a different frame, save that
269 frame's configuration too. */
270 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
271 if (XFRAME (mini_frame
) != selected_frame
)
272 record_unwind_protect (Fset_window_configuration
,
273 Fcurrent_window_configuration (mini_frame
));
275 /* If the minibuffer is on an iconified or invisible frame,
276 make it visible now. */
277 Fmake_frame_visible (mini_frame
);
279 if (minibuffer_auto_raise
)
280 Fraise_frame (mini_frame
);
282 /* We have to do this after saving the window configuration
283 since that is what restores the current buffer. */
285 /* Arrange to restore a number of minibuffer-related variables.
286 We could bind each variable separately, but that would use lots of
289 = Fcons (Voverriding_local_map
,
290 Fcons (minibuf_window
, minibuf_save_list
));
292 = Fcons (minibuf_prompt
,
293 Fcons (make_number (minibuf_prompt_width
),
295 Fcons (Vcurrent_prefix_arg
,
296 Fcons (Vminibuffer_history_position
,
297 Fcons (Vminibuffer_history_variable
,
298 minibuf_save_list
))))));
300 record_unwind_protect (read_minibuf_unwind
, Qnil
);
303 /* Now that we can restore all those variables, start changing them. */
305 minibuf_prompt_width
= 0; /* xdisp.c puts in the right value. */
306 minibuf_prompt
= Fcopy_sequence (prompt
);
307 Vminibuffer_history_position
= histpos
;
308 Vminibuffer_history_variable
= histvar
;
309 Vhelp_form
= Vminibuffer_help_form
;
311 if (inherit_input_method
)
313 /* `current-input-method' is buffer local. So, remeber it in
314 INPUT_METHOD before changing the current buffer. */
315 input_method
= Fsymbol_value (Qcurrent_input_method
);
316 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
319 /* Switch to the minibuffer. */
321 minibuffer
= get_minibuffer (minibuf_level
);
322 Fset_buffer (minibuffer
);
324 /* The current buffer's default directory is usually the right thing
325 for our minibuffer here. However, if you're typing a command at
326 a minibuffer-only frame when minibuf_level is zero, then buf IS
327 the current_buffer, so reset_buffer leaves buf's default
328 directory unchanged. This is a bummer when you've just started
329 up Emacs and buf's default directory is Qnil. Here's a hack; can
330 you think of something better to do? Find another buffer with a
331 better directory, and use that one instead. */
332 if (STRINGP (ambient_dir
))
333 current_buffer
->directory
= ambient_dir
;
336 Lisp_Object buf_list
;
338 for (buf_list
= Vbuffer_alist
;
340 buf_list
= XCONS (buf_list
)->cdr
)
342 Lisp_Object other_buf
;
344 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
345 if (STRINGP (XBUFFER (other_buf
)->directory
))
347 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
353 if (XFRAME (mini_frame
) != selected_frame
)
354 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
356 Vminibuf_scroll_window
= selected_window
;
357 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
358 Fselect_window (minibuf_window
);
359 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
361 Fmake_local_variable (Qprint_escape_newlines
);
362 print_escape_newlines
= 1;
364 /* Erase the buffer. */
366 int count1
= specpdl_ptr
- specpdl
;
367 specbind (Qinhibit_read_only
, Qt
);
369 unbind_to (count1
, Qnil
);
372 /* Put in the initial input. */
375 Finsert (1, &initial
);
376 if (INTEGERP (backup_n
))
377 Fforward_char (backup_n
);
380 echo_area_glyphs
= 0;
381 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
382 previous_echo_glyphs
= 0;
384 current_buffer
->keymap
= map
;
386 /* Turn on an input method stored in INPUT_METHOD if any. */
387 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
388 call1 (Qactivate_input_method
, input_method
);
390 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
391 if (inherit_input_method
)
392 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
394 /* Run our hook, but not if it is empty.
395 (run-hooks would do nothing if it is empty,
396 but it's important to save time here in the usual case). */
397 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
398 && !NILP (Vrun_hooks
))
399 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
401 /* ??? MCC did redraw_screen here if switching screens. */
404 /* If cursor is on the minibuffer line,
405 show the user we have exited by putting it in column 0. */
406 if ((FRAME_CURSOR_Y (selected_frame
)
407 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
410 FRAME_CURSOR_X (selected_frame
)
411 = FRAME_LEFT_SCROLL_BAR_WIDTH (selected_frame
);
412 update_frame (selected_frame
, 1, 1);
415 /* Make minibuffer contents into a string. */
416 Fset_buffer (minibuffer
);
417 val
= make_buffer_string (1, Z
, allow_props
);
418 #if 0 /* make_buffer_string should handle the gap. */
419 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
422 /* VAL is the string of minibuffer text. */
424 last_minibuf_string
= val
;
426 /* Add the value to the appropriate history list unless it is empty. */
427 if (XSTRING (val
)->size
!= 0
428 && SYMBOLP (Vminibuffer_history_variable
)
429 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
431 /* If the caller wanted to save the value read on a history list,
432 then do so if the value is not already the front of the list. */
434 histval
= Fsymbol_value (Vminibuffer_history_variable
);
436 /* The value of the history variable must be a cons or nil. Other
437 values are unacceptable. We silently ignore these values. */
440 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
444 histval
= Fcons (last_minibuf_string
, histval
);
445 Fset (Vminibuffer_history_variable
, histval
);
447 /* Truncate if requested. */
448 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
449 if (NILP (length
)) length
= Vhistory_length
;
450 if (INTEGERP (length
))
452 if (XINT (length
) <= 0)
453 Fset (Vminibuffer_history_variable
, Qnil
);
458 temp
= Fnthcdr (Fsub1 (length
), histval
);
459 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
465 /* If Lisp form desired instead of string, parse it. */
468 Lisp_Object expr_and_pos
;
472 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
473 pos
= XINT (Fcdr (expr_and_pos
));
474 if (pos
!= XSTRING (val
)->size
)
476 /* Ignore trailing whitespace; any other trailing junk is an error. */
478 pos
= string_char_to_byte (val
, pos
);
479 for (i
= pos
; i
< XSTRING (val
)->size_byte
; i
++)
481 int c
= XSTRING (val
)->data
[i
];
482 if (c
!= ' ' && c
!= '\t' && c
!= '\n')
483 error ("Trailing garbage following expression");
486 val
= Fcar (expr_and_pos
);
489 /* The appropriate frame will get selected
490 in set-window-configuration. */
491 RETURN_UNGCPRO (unbind_to (count
, val
));
494 /* Return a buffer to be used as the minibuffer at depth `depth'.
495 depth = 0 is the lowest allowed argument, and that is the value
496 used for nonrecursive minibuffer invocations */
499 get_minibuffer (depth
)
502 Lisp_Object tail
, num
, buf
;
504 extern Lisp_Object
nconc2 ();
506 XSETFASTINT (num
, depth
);
507 tail
= Fnthcdr (num
, Vminibuffer_list
);
510 tail
= Fcons (Qnil
, Qnil
);
511 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
514 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
516 sprintf (name
, " *Minibuf-%d*", depth
);
517 buf
= Fget_buffer_create (build_string (name
));
519 /* Although the buffer's name starts with a space, undo should be
521 Fbuffer_enable_undo (buf
);
523 XCONS (tail
)->car
= buf
;
527 int count
= specpdl_ptr
- specpdl
;
529 reset_buffer (XBUFFER (buf
));
530 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
532 Fkill_all_local_variables ();
533 unbind_to (count
, Qnil
);
539 /* This function is called on exiting minibuffer, whether normally or not,
540 and it restores the current window, buffer, etc. */
543 read_minibuf_unwind (data
)
546 Lisp_Object old_deactivate_mark
;
549 /* We are exiting the minibuffer one way or the other,
551 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
552 && !NILP (Vrun_hooks
))
553 safe_run_hooks (Qminibuffer_exit_hook
);
555 /* If this was a recursive minibuffer,
556 tie the minibuffer window back to the outer level minibuffer buffer. */
559 window
= minibuf_window
;
560 /* To keep things predictable, in case it matters, let's be in the minibuffer
561 when we reset the relevant variables. */
562 Fset_buffer (XWINDOW (window
)->buffer
);
564 /* Restore prompt, etc, from outer minibuffer level. */
565 minibuf_prompt
= Fcar (minibuf_save_list
);
566 minibuf_save_list
= Fcdr (minibuf_save_list
);
567 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
568 minibuf_save_list
= Fcdr (minibuf_save_list
);
569 Vhelp_form
= Fcar (minibuf_save_list
);
570 minibuf_save_list
= Fcdr (minibuf_save_list
);
571 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
572 minibuf_save_list
= Fcdr (minibuf_save_list
);
573 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
574 minibuf_save_list
= Fcdr (minibuf_save_list
);
575 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
576 minibuf_save_list
= Fcdr (minibuf_save_list
);
577 Voverriding_local_map
= Fcar (minibuf_save_list
);
578 minibuf_save_list
= Fcdr (minibuf_save_list
);
580 temp
= Fcar (minibuf_save_list
);
581 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
582 minibuf_window
= temp
;
584 minibuf_save_list
= Fcdr (minibuf_save_list
);
586 /* Erase the minibuffer we were using at this level. */
588 int count
= specpdl_ptr
- specpdl
;
589 /* Prevent error in erase-buffer. */
590 specbind (Qinhibit_read_only
, Qt
);
591 old_deactivate_mark
= Vdeactivate_mark
;
593 Vdeactivate_mark
= old_deactivate_mark
;
594 unbind_to (count
, Qnil
);
597 /* Make sure minibuffer window is erased, not ignored. */
598 windows_or_buffers_changed
++;
599 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
600 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
606 /* This comment supplies the doc string for read-from-minibuffer,
607 for make-docfile to see. We cannot put this in the real DEFUN
608 due to limits in the Unix cpp.
610 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
611 "Read a string from the minibuffer, prompting with string PROMPT.\n\
612 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
613 to be inserted into the minibuffer before reading input.\n\
614 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
615 is STRING, but point is placed at position POSITION in the minibuffer.\n\
616 Third arg KEYMAP is a keymap to use whilst reading;\n\
617 if omitted or nil, the default is `minibuffer-local-map'.\n\
618 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
619 and return that object:\n\
620 in other words, do `(car (read-from-string INPUT-STRING))'\n\
621 Fifth arg HIST, if non-nil, specifies a history list\n\
622 and optionally the initial position in the list.\n\
623 It can be a symbol, which is the history list variable to use,\n\
624 or it can be a cons cell (HISTVAR . HISTPOS).\n\
625 In that case, HISTVAR is the history list variable to use,\n\
626 and HISTPOS is the initial position (the position in the list\n\
627 which INITIAL-CONTENTS corresponds to).\n\
628 Positions are counted starting from 1 at the beginning of the list.\n\
629 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
630 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
631 if the user enters empty input! It returns the empty string.\n\
632 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
633 the current input method and the setting of enable-multibyte-characters.\n\
634 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
635 then the string which is returned includes whatever text properties\n\
636 were present in the minibuffer. Otherwise the value has no text properties.")
637 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
640 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
641 0 /* See immediately above */)
642 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
643 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
644 Lisp_Object inherit_input_method
;
647 Lisp_Object histvar
, histpos
, position
, val
;
652 CHECK_STRING (prompt
, 0);
653 if (!NILP (initial_contents
))
655 if (CONSP (initial_contents
))
657 position
= Fcdr (initial_contents
);
658 initial_contents
= Fcar (initial_contents
);
660 CHECK_STRING (initial_contents
, 1);
661 if (!NILP (position
))
663 CHECK_NUMBER (position
, 0);
664 /* Convert to distance from end of input. */
665 if (XINT (position
) < 1)
666 /* A number too small means the beginning of the string. */
667 pos
= - XSTRING (initial_contents
)->size
;
669 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
674 keymap
= Vminibuffer_local_map
;
676 keymap
= get_keymap (keymap
);
685 histvar
= Fcar_safe (hist
);
686 histpos
= Fcdr_safe (hist
);
689 histvar
= Qminibuffer_history
;
691 XSETFASTINT (histpos
, 0);
693 GCPRO1 (default_value
);
694 val
= read_minibuf (keymap
, initial_contents
, prompt
,
695 make_number (pos
), !NILP (read
),
696 histvar
, histpos
, default_value
,
697 minibuffer_allow_text_properties
,
698 !NILP (inherit_input_method
));
703 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
704 "Return a Lisp object read using the minibuffer.\n\
705 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
706 is a string to insert in the minibuffer before reading.")
707 (prompt
, initial_contents
)
708 Lisp_Object prompt
, initial_contents
;
710 CHECK_STRING (prompt
, 0);
711 if (!NILP (initial_contents
))
712 CHECK_STRING (initial_contents
, 1);
713 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
714 prompt
, Qnil
, 1, Qminibuffer_history
,
715 make_number (0), Qnil
, 0, 0);
718 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
719 "Return value of Lisp expression read using the minibuffer.\n\
720 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
721 is a string to insert in the minibuffer before reading.")
722 (prompt
, initial_contents
)
723 Lisp_Object prompt
, initial_contents
;
725 return Feval (Fread_minibuffer (prompt
, initial_contents
));
728 /* Functions that use the minibuffer to read various things. */
730 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
731 "Read a string from the minibuffer, prompting with string PROMPT.\n\
732 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
733 The third arg HISTORY, if non-nil, specifies a history list\n\
734 and optionally the initial position in the list.\n\
735 See `read-from-minibuffer' for details of HISTORY argument.\n\
736 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
737 for history commands, and as the value to return if the user enters\n\
739 Fifth 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
, initial_input
, history
, default_value
, inherit_input_method
)
742 Lisp_Object prompt
, initial_input
, history
, default_value
;
743 Lisp_Object inherit_input_method
;
746 val
= Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
747 Qnil
, history
, default_value
,
748 inherit_input_method
);
749 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
754 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
755 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
756 Prompt with PROMPT, and provide INIT as an initial value of the input string.\n\
757 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
758 the current input method and the setting of enable-multibyte-characters.")
759 (prompt
, init
, inherit_input_method
)
760 Lisp_Object prompt
, init
, inherit_input_method
;
762 CHECK_STRING (prompt
, 0);
764 CHECK_STRING (init
, 1);
766 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
,
767 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
768 !NILP (inherit_input_method
));
771 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
772 "Read the name of a command and return as a symbol.\n\
773 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
774 (prompt
, default_value
)
775 Lisp_Object prompt
, default_value
;
777 Lisp_Object name
, default_string
;
779 if (NILP (default_value
))
780 default_string
= Qnil
;
781 else if (SYMBOLP (default_value
))
782 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
784 default_string
= default_value
;
786 name
= Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
787 Qnil
, Qnil
, default_string
, Qnil
);
790 return Fintern (name
, Qnil
);
794 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
795 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
796 Prompts with PROMPT.")
800 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
805 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
806 "Read the name of a user variable and return it as a symbol.\n\
807 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
808 A user variable is one whose documentation starts with a `*' character.")
809 (prompt
, default_value
)
810 Lisp_Object prompt
, default_value
;
812 Lisp_Object name
, default_string
;
814 if (NILP (default_value
))
815 default_string
= Qnil
;
816 else if (SYMBOLP (default_value
))
817 XSETSTRING (default_string
, XSYMBOL (default_value
)->name
);
819 default_string
= default_value
;
821 name
= Fcompleting_read (prompt
, Vobarray
,
822 Quser_variable_p
, Qt
,
823 Qnil
, Qnil
, default_string
, Qnil
);
826 return Fintern (name
, Qnil
);
829 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
830 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
831 Prompts with PROMPT.\n\
832 Optional second arg DEF is value to return if user enters an empty line.\n\
833 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
834 (prompt
, def
, require_match
)
835 Lisp_Object prompt
, def
, require_match
;
841 def
= XBUFFER (def
)->name
;
843 if (NILP (Vread_buffer_function
))
847 args
[0] = build_string ("%s(default %s) ");
850 prompt
= Fformat (3, args
);
853 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
854 require_match
, Qnil
, Qnil
, def
, Qnil
);
858 args
[0] = Vread_buffer_function
;
861 args
[3] = require_match
;
862 return Ffuncall(4, args
);
866 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
867 "Return common substring of all completions of STRING in ALIST.\n\
868 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
869 All that match are compared together; the longest initial sequence\n\
870 common to all matches is returned as a string.\n\
871 If there is no match at all, nil is returned.\n\
872 For an exact match, t is returned.\n\
874 ALIST can be an obarray instead of an alist.\n\
875 Then the print names of all symbols in the obarray are the possible matches.\n\
877 ALIST can also be a function to do the completion itself.\n\
878 It receives three arguments: the values STRING, PREDICATE and nil.\n\
879 Whatever it returns becomes the value of `try-completion'.\n\
881 If optional third argument PREDICATE is non-nil,\n\
882 it is used to test each possible match.\n\
883 The match is a candidate only if PREDICATE returns non-nil.\n\
884 The argument given to PREDICATE is the alist element\n\
885 or the symbol from the obarray.")
886 (string
, alist
, predicate
)
887 Lisp_Object string
, alist
, predicate
;
889 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
890 /* Size in bytes of BESTMATCH. */
892 /* These are in bytes, too. */
893 int compare
, matchsize
;
894 int list
= CONSP (alist
) || NILP (alist
);
897 Lisp_Object bucket
, zero
, end
, tem
;
898 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
900 CHECK_STRING (string
, 0);
901 if (!list
&& !VECTORP (alist
))
902 return call3 (alist
, string
, predicate
, Qnil
);
906 /* If ALIST is not a list, set TAIL just for gc pro. */
911 obsize
= XVECTOR (alist
)->size
;
912 bucket
= XVECTOR (alist
)->contents
[index
];
917 /* Get the next element of the alist or obarray. */
918 /* Exit the loop if the elements are all used up. */
919 /* elt gets the alist element or symbol.
920 eltstring gets the name to check as a completion. */
927 eltstring
= Fcar (elt
);
932 if (XFASTINT (bucket
) != 0)
935 eltstring
= Fsymbol_name (elt
);
936 if (XSYMBOL (bucket
)->next
)
937 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
939 XSETFASTINT (bucket
, 0);
941 else if (++index
>= obsize
)
945 bucket
= XVECTOR (alist
)->contents
[index
];
950 /* Is this element a possible completion? */
952 if (STRINGP (eltstring
)
953 && XSTRING (string
)->size_byte
<= XSTRING (eltstring
)->size_byte
954 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
955 XSTRING (string
)->size_byte
))
960 XSETFASTINT (zero
, 0);
962 /* Ignore this element if it fails to match all the regexps. */
963 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
964 regexps
= XCONS (regexps
)->cdr
)
966 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
973 /* Ignore this element if there is a predicate
974 and the predicate doesn't like it. */
976 if (!NILP (predicate
))
978 if (EQ (predicate
, Qcommandp
))
979 tem
= Fcommandp (elt
);
982 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
983 tem
= call1 (predicate
, elt
);
986 if (NILP (tem
)) continue;
989 /* Update computation of how much all possible completions match */
992 if (NILP (bestmatch
))
994 bestmatch
= eltstring
;
995 bestmatchsize
= XSTRING (eltstring
)->size_byte
;
999 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size_byte
);
1000 matchsize
= scmp (XSTRING (bestmatch
)->data
,
1001 XSTRING (eltstring
)->data
,
1004 matchsize
= compare
;
1005 if (completion_ignore_case
)
1007 /* If this is an exact match except for case,
1008 use it as the best match rather than one that is not an
1009 exact match. This way, we get the case pattern
1010 of the actual match. */
1011 if ((matchsize
== XSTRING (eltstring
)->size_byte
1012 && matchsize
< XSTRING (bestmatch
)->size_byte
)
1014 /* If there is more than one exact match ignoring case,
1015 and one of them is exact including case,
1017 /* If there is no exact match ignoring case,
1018 prefer a match that does not change the case
1020 ((matchsize
== XSTRING (eltstring
)->size_byte
)
1022 (matchsize
== XSTRING (bestmatch
)->size_byte
)
1023 && !bcmp (XSTRING (eltstring
)->data
,
1024 XSTRING (string
)->data
,
1025 XSTRING (string
)->size_byte
)
1026 && bcmp (XSTRING (bestmatch
)->data
,
1027 XSTRING (string
)->data
,
1028 XSTRING (string
)->size_byte
)))
1029 bestmatch
= eltstring
;
1031 bestmatchsize
= matchsize
;
1036 if (NILP (bestmatch
))
1037 return Qnil
; /* No completions found */
1038 /* If we are ignoring case, and there is no exact match,
1039 and no additional text was supplied,
1040 don't change the case of what the user typed. */
1041 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size_byte
1042 && XSTRING (bestmatch
)->size_byte
> bestmatchsize
)
1045 /* Return t if the supplied string is an exact match (counting case);
1046 it does not require any change to be made. */
1047 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size_byte
1048 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
1052 bestmatchsize
= string_byte_to_char (bestmatch
, bestmatchsize
);
1054 XSETFASTINT (zero
, 0); /* Else extract the part in which */
1055 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
1056 return Fsubstring (bestmatch
, zero
, end
);
1059 /* Compare exactly LEN chars of strings at S1 and S2,
1060 ignoring case if appropriate.
1061 Return -1 if strings match,
1062 else number of chars that match at the beginning. */
1066 register unsigned char *s1
, *s2
;
1069 register int l
= len
;
1070 register unsigned char *start
= s1
;
1072 if (completion_ignore_case
)
1074 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1079 while (l
&& *s1
++ == *s2
++)
1086 int match
= len
- l
;
1088 /* Now *--S1 is the unmatching byte. If it is in the middle of
1089 multi-byte form, we must say that the multi-byte character
1090 there doesn't match. */
1091 while (match
&& *--s1
>= 0xA0) match
--;
1096 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1097 "Search for partial matches to STRING in ALIST.\n\
1098 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1099 The value is a list of all the strings from ALIST that match.\n\
1101 ALIST can be an obarray instead of an alist.\n\
1102 Then the print names of all symbols in the obarray are the possible matches.\n\
1104 ALIST can also be a function to do the completion itself.\n\
1105 It receives three arguments: the values STRING, PREDICATE and t.\n\
1106 Whatever it returns becomes the value of `all-completion'.\n\
1108 If optional third argument PREDICATE is non-nil,\n\
1109 it is used to test each possible match.\n\
1110 The match is a candidate only if PREDICATE returns non-nil.\n\
1111 The argument given to PREDICATE is the alist element\n\
1112 or the symbol from the obarray.\n\
1114 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1115 strings in ALIST that start with a space\n\
1116 are ignored unless STRING itself starts with a space.")
1117 (string
, alist
, predicate
, hide_spaces
)
1118 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1120 Lisp_Object tail
, elt
, eltstring
;
1121 Lisp_Object allmatches
;
1122 int list
= CONSP (alist
) || NILP (alist
);
1124 Lisp_Object bucket
, tem
;
1125 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1127 CHECK_STRING (string
, 0);
1128 if (!list
&& !VECTORP (alist
))
1130 return call3 (alist
, string
, predicate
, Qt
);
1134 /* If ALIST is not a list, set TAIL just for gc pro. */
1139 obsize
= XVECTOR (alist
)->size
;
1140 bucket
= XVECTOR (alist
)->contents
[index
];
1145 /* Get the next element of the alist or obarray. */
1146 /* Exit the loop if the elements are all used up. */
1147 /* elt gets the alist element or symbol.
1148 eltstring gets the name to check as a completion. */
1155 eltstring
= Fcar (elt
);
1160 if (XFASTINT (bucket
) != 0)
1163 eltstring
= Fsymbol_name (elt
);
1164 if (XSYMBOL (bucket
)->next
)
1165 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1167 XSETFASTINT (bucket
, 0);
1169 else if (++index
>= obsize
)
1173 bucket
= XVECTOR (alist
)->contents
[index
];
1178 /* Is this element a possible completion? */
1180 if (STRINGP (eltstring
)
1181 && XSTRING (string
)->size_byte
<= XSTRING (eltstring
)->size_byte
1182 /* If HIDE_SPACES, reject alternatives that start with space
1183 unless the input starts with space. */
1184 && ((XSTRING (string
)->size_byte
> 0
1185 && XSTRING (string
)->data
[0] == ' ')
1186 || XSTRING (eltstring
)->data
[0] != ' '
1187 || NILP (hide_spaces
))
1188 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1189 XSTRING (string
)->size_byte
))
1192 Lisp_Object regexps
;
1194 XSETFASTINT (zero
, 0);
1196 /* Ignore this element if it fails to match all the regexps. */
1197 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1198 regexps
= XCONS (regexps
)->cdr
)
1200 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1204 if (CONSP (regexps
))
1207 /* Ignore this element if there is a predicate
1208 and the predicate doesn't like it. */
1210 if (!NILP (predicate
))
1212 if (EQ (predicate
, Qcommandp
))
1213 tem
= Fcommandp (elt
);
1216 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1217 tem
= call1 (predicate
, elt
);
1220 if (NILP (tem
)) continue;
1222 /* Ok => put it on the list. */
1223 allmatches
= Fcons (eltstring
, allmatches
);
1227 return Fnreverse (allmatches
);
1230 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1231 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1232 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1234 /* This comment supplies the doc string for completing-read,
1235 for make-docfile to see. We cannot put this in the real DEFUN
1236 due to limits in the Unix cpp.
1238 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1239 "Read a string in the minibuffer, with completion.\n\
1240 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1241 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1242 PREDICATE limits completion to a subset of TABLE.\n\
1243 See `try-completion' and `all-completions' for more details
1244 on completion, TABLE, and PREDICATE.\n\
1246 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1247 the input is (or completes to) an element of TABLE or is null.\n\
1248 If it is also not t, Return does not exit if it does non-null completion.\n\
1249 If the input is null, `completing-read' returns an empty string,\n\
1250 regardless of the value of REQUIRE-MATCH.\n\
1252 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1253 If it is (STRING . POSITION), the initial input\n\
1254 is STRING, but point is placed POSITION characters into the string.\n\
1255 HIST, if non-nil, specifies a history list\n\
1256 and optionally the initial position in the list.\n\
1257 It can be a symbol, which is the history list variable to use,\n\
1258 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1259 In that case, HISTVAR is the history list variable to use,\n\
1260 and HISTPOS is the initial position (the position in the list\n\
1261 which INITIAL-INPUT corresponds to).\n\
1262 Positions are counted starting from 1 at the beginning of the list.\n\
1263 DEF, if non-nil, is the default value.\n\
1265 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1266 the current input method and the setting of enable-multibyte-characters.\n\
1268 Completion ignores case if the ambient value of\n\
1269 `completion-ignore-case' is non-nil."
1271 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1272 0 /* See immediately above */)
1273 (prompt
, table
, predicate
, require_match
, init
, hist
, def
, inherit_input_method
)
1274 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
, def
;
1275 Lisp_Object inherit_input_method
;
1277 Lisp_Object val
, histvar
, histpos
, position
;
1279 int count
= specpdl_ptr
- specpdl
;
1280 struct gcpro gcpro1
;
1281 int disable_multibyte
= EQ (table
, Qread_file_name_internal
);
1285 specbind (Qminibuffer_completion_table
, table
);
1286 specbind (Qminibuffer_completion_predicate
, predicate
);
1287 specbind (Qminibuffer_completion_confirm
,
1288 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1289 last_exact_completion
= Qnil
;
1296 position
= Fcdr (init
);
1299 CHECK_STRING (init
, 0);
1300 if (!NILP (position
))
1302 CHECK_NUMBER (position
, 0);
1303 /* Convert to distance from end of input. */
1304 pos
= XINT (position
) - XSTRING (init
)->size
;
1315 histvar
= Fcar_safe (hist
);
1316 histpos
= Fcdr_safe (hist
);
1319 histvar
= Qminibuffer_history
;
1321 XSETFASTINT (histpos
, 0);
1323 val
= read_minibuf (NILP (require_match
)
1324 ? Vminibuffer_local_completion_map
1325 : Vminibuffer_local_must_match_map
,
1326 init
, prompt
, make_number (pos
), 0,
1327 histvar
, histpos
, def
, 0,
1328 !NILP (inherit_input_method
));
1330 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1333 RETURN_UNGCPRO (unbind_to (count
, val
));
1336 Lisp_Object
Fminibuffer_completion_help ();
1337 Lisp_Object
assoc_for_completion ();
1339 /* Test whether TXT is an exact completion. */
1341 test_completion (txt
)
1346 if (CONSP (Vminibuffer_completion_table
)
1347 || NILP (Vminibuffer_completion_table
))
1348 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1349 else if (VECTORP (Vminibuffer_completion_table
))
1351 /* Bypass intern-soft as that loses for nil */
1352 tem
= oblookup (Vminibuffer_completion_table
,
1353 XSTRING (txt
)->data
,
1354 XSTRING (txt
)->size
,
1355 XSTRING (txt
)->size_byte
);
1358 else if (!NILP (Vminibuffer_completion_predicate
))
1359 return call1 (Vminibuffer_completion_predicate
, tem
);
1364 return call3 (Vminibuffer_completion_table
, txt
,
1365 Vminibuffer_completion_predicate
, Qlambda
);
1369 * 0 no possible completion
1370 * 1 was already an exact and unique completion
1371 * 3 was already an exact completion
1372 * 4 completed to an exact completion
1373 * 5 some completion happened
1374 * 6 no completion happened
1379 Lisp_Object completion
, tem
;
1382 struct gcpro gcpro1
, gcpro2
;
1384 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1385 Vminibuffer_completion_predicate
);
1386 last
= last_exact_completion
;
1387 last_exact_completion
= Qnil
;
1389 GCPRO2 (completion
, last
);
1391 if (NILP (completion
))
1394 temp_echo_area_glyphs (" [No match]");
1399 if (EQ (completion
, Qt
)) /* exact and unique match */
1406 tem
= Fstring_equal (completion
, Fbuffer_string());
1407 if (completedp
= NILP (tem
))
1409 Ferase_buffer (); /* Some completion happened */
1410 Finsert (1, &completion
);
1413 /* It did find a match. Do we match some possibility exactly now? */
1414 tem
= test_completion (Fbuffer_string ());
1417 /* not an exact match */
1422 Fminibuffer_completion_help ();
1424 temp_echo_area_glyphs (" [Next char not unique]");
1427 else if (completedp
)
1432 /* If the last exact completion and this one were the same,
1433 it means we've already given a "Complete but not unique"
1434 message and the user's hit TAB again, so now we give him help. */
1435 last_exact_completion
= completion
;
1438 tem
= Fbuffer_string ();
1439 if (!NILP (Fequal (tem
, last
)))
1440 Fminibuffer_completion_help ();
1446 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1449 assoc_for_completion (key
, list
)
1450 register Lisp_Object key
;
1453 register Lisp_Object tail
;
1455 if (completion_ignore_case
)
1456 key
= Fupcase (key
);
1458 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1460 register Lisp_Object elt
, tem
, thiscar
;
1462 if (!CONSP (elt
)) continue;
1463 thiscar
= Fcar (elt
);
1464 if (!STRINGP (thiscar
))
1466 if (completion_ignore_case
)
1467 thiscar
= Fupcase (thiscar
);
1468 tem
= Fequal (thiscar
, key
);
1469 if (!NILP (tem
)) return elt
;
1475 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1476 "Complete the minibuffer contents as far as possible.\n\
1477 Return nil if there is no valid completion, else t.\n\
1478 If no characters can be completed, display a list of possible completions.\n\
1479 If you repeat this command after it displayed such a list,\n\
1480 scroll the window of possible completions.")
1484 Lisp_Object window
, tem
;
1486 /* If the previous command was not this, then mark the completion
1488 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1489 Vminibuf_scroll_window
= Qnil
;
1491 window
= Vminibuf_scroll_window
;
1492 /* If there's a fresh completion window with a live buffer,
1493 and this command is repeated, scroll that window. */
1494 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1495 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1497 struct buffer
*obuf
= current_buffer
;
1499 Fset_buffer (XWINDOW (window
)->buffer
);
1500 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1502 /* If end is in view, scroll up to the beginning. */
1503 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1505 /* Else scroll down one screen. */
1506 Fscroll_other_window (Qnil
);
1508 set_buffer_internal (obuf
);
1512 i
= do_completion ();
1519 temp_echo_area_glyphs (" [Sole completion]");
1523 temp_echo_area_glyphs (" [Complete, but not unique]");
1530 /* Subroutines of Fminibuffer_complete_and_exit. */
1532 /* This one is called by internal_condition_case to do the real work. */
1535 complete_and_exit_1 ()
1537 return make_number (do_completion ());
1540 /* This one is called by internal_condition_case if an error happens.
1541 Pretend the current value is an exact match. */
1544 complete_and_exit_2 (ignore
)
1547 return make_number (1);
1550 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1551 Sminibuffer_complete_and_exit
, 0, 0, "",
1552 "If the minibuffer contents is a valid completion then exit.\n\
1553 Otherwise try to complete it. If completion leads to a valid completion,\n\
1554 a repetition of this command will exit.")
1560 /* Allow user to specify null string */
1564 if (!NILP (test_completion (Fbuffer_string ())))
1567 /* Call do_completion, but ignore errors. */
1568 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1569 complete_and_exit_2
);
1579 if (!NILP (Vminibuffer_completion_confirm
))
1581 temp_echo_area_glyphs (" [Confirm]");
1591 Fthrow (Qexit
, Qnil
);
1595 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1597 "Complete the minibuffer contents at most a single word.\n\
1598 After one word is completed as much as possible, a space or hyphen\n\
1599 is added, provided that matches some possible completion.\n\
1600 Return nil if there is no valid completion, else t.")
1603 Lisp_Object completion
, tem
;
1604 register int i
, i_byte
;
1605 register unsigned char *completion_string
;
1606 struct gcpro gcpro1
, gcpro2
;
1608 /* We keep calling Fbuffer_string rather than arrange for GC to
1609 hold onto a pointer to one of the strings thus made. */
1611 completion
= Ftry_completion (Fbuffer_string (),
1612 Vminibuffer_completion_table
,
1613 Vminibuffer_completion_predicate
);
1614 if (NILP (completion
))
1617 temp_echo_area_glyphs (" [No match]");
1620 if (EQ (completion
, Qt
))
1623 #if 0 /* How the below code used to look, for reference. */
1624 tem
= Fbuffer_string ();
1625 b
= XSTRING (tem
)->data
;
1626 i
= ZV
- 1 - XSTRING (completion
)->size
;
1627 p
= XSTRING (completion
)->data
;
1629 0 <= scmp (b
, p
, ZV
- 1))
1632 /* Set buffer to longest match of buffer tail and completion head. */
1633 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1635 del_range (1, i
+ 1);
1638 #else /* Rewritten code */
1640 register unsigned char *buffer_string
;
1641 int buffer_nbytes
, completion_nbytes
;
1643 CHECK_STRING (completion
, 0);
1644 tem
= Fbuffer_string ();
1645 GCPRO2 (completion
, tem
);
1646 /* If reading a file name,
1647 expand any $ENVVAR refs in the buffer and in TEM. */
1648 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1650 Lisp_Object substituted
;
1651 substituted
= Fsubstitute_in_file_name (tem
);
1652 if (! EQ (substituted
, tem
))
1656 insert_from_string (tem
, 0, 0, XSTRING (tem
)->size
,
1657 XSTRING (tem
)->size_byte
, 0);
1660 buffer_string
= XSTRING (tem
)->data
;
1661 completion_string
= XSTRING (completion
)->data
;
1662 buffer_nbytes
= XSTRING (tem
)->size_byte
; /* ie ZV_BYTE - BEGV_BYTE */
1663 completion_nbytes
= XSTRING (completion
)->size_byte
;
1664 i_byte
= buffer_nbytes
- completion_nbytes
;
1666 0 <= scmp (buffer_string
, completion_string
, buffer_nbytes
))
1668 /* Set buffer to longest match of buffer tail and completion head. */
1669 if (i_byte
<= 0) i_byte
= 1;
1670 buffer_string
+= i_byte
;
1671 buffer_nbytes
-= i_byte
;
1672 while (0 <= scmp (buffer_string
++, completion_string
, buffer_nbytes
--))
1674 del_range_byte (1, i_byte
+ 1, 1);
1675 SET_PT_BOTH (ZV
, ZV_BYTE
);
1679 #endif /* Rewritten code */
1680 i_byte
= ZV_BYTE
- BEGV_BYTE
;
1683 /* If completion finds next char not unique,
1684 consider adding a space or a hyphen. */
1685 if (i
== XSTRING (completion
)->size
)
1687 GCPRO1 (completion
);
1688 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1689 Vminibuffer_completion_table
,
1690 Vminibuffer_completion_predicate
);
1697 GCPRO1 (completion
);
1699 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1700 Vminibuffer_completion_table
,
1701 Vminibuffer_completion_predicate
);
1709 /* Now find first word-break in the stuff found by completion.
1710 i gets index in string of where to stop completing. */
1714 completion_string
= XSTRING (completion
)->data
;
1715 for (; i_byte
< XSTRING (completion
)->size_byte
; i_byte
+= len
, i
++)
1717 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i_byte
,
1718 XSTRING (completion
)->size
- i_byte
,
1720 if (SYNTAX (c
) != Sword
)
1729 /* If got no characters, print help for user. */
1731 if (i_byte
== ZV_BYTE
- BEGV_BYTE
)
1734 Fminibuffer_completion_help ();
1738 /* Otherwise insert in minibuffer the chars we got */
1741 insert_from_string (completion
, 0, 0, i
, i_byte
, 1);
1745 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1747 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1748 Each element may be just a symbol or string\n\
1749 or may be a list of two strings to be printed as if concatenated.\n\
1750 `standard-output' must be a buffer.\n\
1751 At the end, run the normal hook `completion-setup-hook'.\n\
1752 It can find the completion buffer in `standard-output'.")
1754 Lisp_Object completions
;
1756 Lisp_Object tail
, elt
;
1759 struct gcpro gcpro1
, gcpro2
;
1760 struct buffer
*old
= current_buffer
;
1763 /* Note that (when it matters) every variable
1764 points to a non-string that is pointed to by COMPLETIONS,
1765 except for ELT. ELT can be pointing to a string
1766 when terpri or Findent_to calls a change hook. */
1768 GCPRO2 (completions
, elt
);
1770 if (BUFFERP (Vstandard_output
))
1771 set_buffer_internal (XBUFFER (Vstandard_output
));
1773 if (NILP (completions
))
1774 write_string ("There are no possible completions of what you have typed.",
1778 write_string ("Possible completions are:", -1);
1779 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1783 Lisp_Object startpos
, endpos
;
1786 /* Compute the length of this element. */
1790 CHECK_STRING (tem
, 0);
1791 length
= XSTRING (tem
)->size
;
1793 tem
= Fcar (XCDR (elt
));
1794 CHECK_STRING (tem
, 0);
1795 length
+= XSTRING (tem
)->size
;
1799 CHECK_STRING (elt
, 0);
1800 length
= XSTRING (elt
)->size
;
1803 /* This does a bad job for narrower than usual windows.
1804 Sadly, the window it will appear in is not known
1805 until after the text has been made. */
1807 if (BUFFERP (Vstandard_output
))
1808 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1810 /* If the previous completion was very wide,
1811 or we have two on this line already,
1812 don't put another on the same line. */
1813 if (column
> 33 || first
1814 /* If this is really wide, don't put it second on a line. */
1815 || column
> 0 && length
> 45)
1820 /* Otherwise advance to column 35. */
1823 if (BUFFERP (Vstandard_output
))
1825 tem
= Findent_to (make_number (35), make_number (2));
1827 column
= XINT (tem
);
1833 write_string (" ", -1);
1836 while (column
< 35);
1840 if (BUFFERP (Vstandard_output
))
1842 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1843 Fset_text_properties (startpos
, endpos
,
1844 Qnil
, Vstandard_output
);
1847 /* Output this element and update COLUMN. */
1850 Fprinc (Fcar (elt
), Qnil
);
1851 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1858 /* If output is to a buffer, recompute COLUMN in a way
1859 that takes account of character widths. */
1860 if (BUFFERP (Vstandard_output
))
1862 tem
= Fcurrent_column ();
1863 column
= XINT (tem
);
1872 if (BUFFERP (Vstandard_output
))
1873 set_buffer_internal (old
);
1875 if (!NILP (Vrun_hooks
))
1876 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1881 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1883 "Display a list of possible completions of the current minibuffer contents.")
1886 Lisp_Object completions
;
1888 message ("Making completion list...");
1889 completions
= Fall_completions (Fbuffer_string (),
1890 Vminibuffer_completion_table
,
1891 Vminibuffer_completion_predicate
,
1893 echo_area_glyphs
= 0;
1895 if (NILP (completions
))
1898 temp_echo_area_glyphs (" [No completions]");
1901 internal_with_output_to_temp_buffer ("*Completions*",
1902 Fdisplay_completion_list
,
1903 Fsort (completions
, Qstring_lessp
));
1907 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1908 "Terminate minibuffer input.")
1911 if (INTEGERP (last_command_char
))
1912 internal_self_insert (last_command_char
, 0);
1916 Fthrow (Qexit
, Qnil
);
1919 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1920 "Terminate this minibuffer argument.")
1923 Fthrow (Qexit
, Qnil
);
1926 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1927 "Return current depth of activations of minibuffer, a nonnegative integer.")
1930 return make_number (minibuf_level
);
1933 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1934 "Return the prompt string of the currently-active minibuffer.\n\
1935 If no minibuffer is active, return nil.")
1938 return Fcopy_sequence (minibuf_prompt
);
1941 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1942 Sminibuffer_prompt_width
, 0, 0, 0,
1943 "Return the display width of the minibuffer prompt.")
1947 XSETFASTINT (width
, minibuf_prompt_width
);
1951 /* Temporarily display the string M at the end of the current
1952 minibuffer contents. This is used to display things like
1953 "[No Match]" when the user requests a completion for a prefix
1954 that has no possible completions, and other quick, unobtrusive
1958 temp_echo_area_glyphs (m
)
1962 int osize_byte
= ZV_BYTE
;
1964 int opoint_byte
= PT_BYTE
;
1965 Lisp_Object oinhibit
;
1966 oinhibit
= Vinhibit_quit
;
1968 /* Clear out any old echo-area message to make way for our new thing. */
1971 SET_PT_BOTH (osize
, osize_byte
);
1973 SET_PT_BOTH (opoint
, opoint_byte
);
1975 Fsit_for (make_number (2), Qnil
, Qnil
);
1976 del_range_both (osize
, ZV
, osize_byte
, ZV_BYTE
, 1);
1977 SET_PT_BOTH (opoint
, opoint_byte
);
1978 if (!NILP (Vquit_flag
))
1981 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1983 Vinhibit_quit
= oinhibit
;
1986 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
1988 "Temporarily display STRING at the end of the minibuffer.\n\
1989 The text is displayed for two seconds,\n\
1990 or until the next input event arrives, whichever comes first.")
1994 temp_echo_area_glyphs (XSTRING (string
)->data
);
1999 init_minibuf_once ()
2001 Vminibuffer_list
= Qnil
;
2002 staticpro (&Vminibuffer_list
);
2009 minibuf_prompt
= Qnil
;
2010 staticpro (&minibuf_prompt
);
2012 minibuf_save_list
= Qnil
;
2013 staticpro (&minibuf_save_list
);
2015 Qread_file_name_internal
= intern ("read-file-name-internal");
2016 staticpro (&Qread_file_name_internal
);
2018 Qminibuffer_default
= intern ("minibuffer-default");
2019 staticpro (&Qminibuffer_default
);
2020 Fset (Qminibuffer_default
, Qnil
);
2022 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
2023 staticpro (&Qminibuffer_completion_table
);
2025 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
2026 staticpro (&Qminibuffer_completion_confirm
);
2028 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
2029 staticpro (&Qminibuffer_completion_predicate
);
2031 staticpro (&last_exact_completion
);
2032 last_exact_completion
= Qnil
;
2034 staticpro (&last_minibuf_string
);
2035 last_minibuf_string
= Qnil
;
2037 Quser_variable_p
= intern ("user-variable-p");
2038 staticpro (&Quser_variable_p
);
2040 Qminibuffer_history
= intern ("minibuffer-history");
2041 staticpro (&Qminibuffer_history
);
2043 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
2044 staticpro (&Qminibuffer_setup_hook
);
2046 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
2047 staticpro (&Qminibuffer_exit_hook
);
2049 Qhistory_length
= intern ("history-length");
2050 staticpro (&Qhistory_length
);
2052 Qcurrent_input_method
= intern ("current-input-method");
2053 staticpro (&Qcurrent_input_method
);
2055 Qactivate_input_method
= intern ("activate-input-method");
2056 staticpro (&Qactivate_input_method
);
2058 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function
,
2059 "If this is non-nil, `read-buffer' does its work by calling this function.");
2060 Vread_buffer_function
= Qnil
;
2062 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
2063 "Normal hook run just after entry to minibuffer.");
2064 Vminibuffer_setup_hook
= Qnil
;
2066 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
2067 "Normal hook run just after exit from minibuffer.");
2068 Vminibuffer_exit_hook
= Qnil
;
2070 DEFVAR_LISP ("history-length", &Vhistory_length
,
2071 "*Maximum length for history lists before truncation takes place.\n\
2072 A number means that length; t means infinite. Truncation takes place\n\
2073 just after a new element is inserted. Setting the history-length\n\
2074 property of a history variable overrides this default.");
2075 XSETFASTINT (Vhistory_length
, 30);
2077 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
2078 "*Non-nil means automatically provide help for invalid completion input.");
2081 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2082 "Non-nil means don't consider case significant in completion.");
2083 completion_ignore_case
= 0;
2085 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2086 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2087 This variable makes a difference whenever the minibuffer window is active.");
2088 enable_recursive_minibuffers
= 0;
2090 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2091 "Alist or obarray used for completion in the minibuffer.\n\
2092 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2094 The value may alternatively be a function, which is given three arguments:\n\
2095 STRING, the current buffer contents;\n\
2096 PREDICATE, the predicate for filtering possible matches;\n\
2097 CODE, which says what kind of things to do.\n\
2098 CODE can be nil, t or `lambda'.\n\
2099 nil means to return the best completion of STRING, or nil if there is none.\n\
2100 t means to return a list of all possible completions of STRING.\n\
2101 `lambda' means to return t if STRING is a valid completion as it stands.");
2102 Vminibuffer_completion_table
= Qnil
;
2104 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2105 "Within call to `completing-read', this holds the PREDICATE argument.");
2106 Vminibuffer_completion_predicate
= Qnil
;
2108 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2109 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2110 Vminibuffer_completion_confirm
= Qnil
;
2112 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2113 "Value that `help-form' takes on inside the minibuffer.");
2114 Vminibuffer_help_form
= Qnil
;
2116 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2117 "History list symbol to add minibuffer values to.\n\
2118 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2120 (set minibuffer-history-variable\n\
2121 (cons STRING (symbol-value minibuffer-history-variable)))");
2122 XSETFASTINT (Vminibuffer_history_variable
, 0);
2124 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2125 "Current position of redoing in the history list.");
2126 Vminibuffer_history_position
= Qnil
;
2128 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2129 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2130 Some uses of the echo area also raise that frame (since they use it too).");
2131 minibuffer_auto_raise
= 0;
2133 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2134 "List of regexps that should restrict possible completions.");
2135 Vcompletion_regexp_list
= Qnil
;
2137 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2138 &minibuffer_allow_text_properties
,
2139 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2140 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2141 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2142 with completion; they always discard text properties.");
2143 minibuffer_allow_text_properties
= 0;
2145 defsubr (&Sset_minibuffer_window
);
2146 defsubr (&Sread_from_minibuffer
);
2147 defsubr (&Seval_minibuffer
);
2148 defsubr (&Sread_minibuffer
);
2149 defsubr (&Sread_string
);
2150 defsubr (&Sread_command
);
2151 defsubr (&Sread_variable
);
2152 defsubr (&Sread_buffer
);
2153 defsubr (&Sread_no_blanks_input
);
2154 defsubr (&Sminibuffer_depth
);
2155 defsubr (&Sminibuffer_prompt
);
2156 defsubr (&Sminibuffer_prompt_width
);
2158 defsubr (&Stry_completion
);
2159 defsubr (&Sall_completions
);
2160 defsubr (&Scompleting_read
);
2161 defsubr (&Sminibuffer_complete
);
2162 defsubr (&Sminibuffer_complete_word
);
2163 defsubr (&Sminibuffer_complete_and_exit
);
2164 defsubr (&Sdisplay_completion_list
);
2165 defsubr (&Sminibuffer_completion_help
);
2167 defsubr (&Sself_insert_and_exit
);
2168 defsubr (&Sexit_minibuffer
);
2170 defsubr (&Sminibuffer_message
);
2176 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2177 "abort-recursive-edit");
2178 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2180 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2183 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2184 "abort-recursive-edit");
2185 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2187 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2190 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2192 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2194 initial_define_key (Vminibuffer_local_ns_map
, '?',
2195 "self-insert-and-exit");
2197 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2198 "abort-recursive-edit");
2199 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2201 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2204 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2205 "minibuffer-complete");
2206 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2207 "minibuffer-complete-word");
2208 initial_define_key (Vminibuffer_local_completion_map
, '?',
2209 "minibuffer-completion-help");
2211 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2212 "abort-recursive-edit");
2213 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2214 "minibuffer-complete-and-exit");
2215 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2216 "minibuffer-complete-and-exit");
2217 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2218 "minibuffer-complete");
2219 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2220 "minibuffer-complete-word");
2221 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2222 "minibuffer-completion-help");