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 /* Nonzero means completion ignores case. */
91 int completion_ignore_case
;
93 /* List of regexps that should restrict possible completions. */
95 Lisp_Object Vcompletion_regexp_list
;
97 /* Nonzero means raise the minibuffer frame when the minibuffer
100 int minibuffer_auto_raise
;
102 /* If last completion attempt reported "Complete but not unique"
103 then this is the string completed then; otherwise this is nil. */
105 static Lisp_Object last_exact_completion
;
107 Lisp_Object Quser_variable_p
;
109 Lisp_Object Qminibuffer_default
;
111 /* Non-nil means it is the window for C-M-v to scroll
112 when the minibuffer is selected. */
113 extern Lisp_Object Vminibuf_scroll_window
;
115 extern Lisp_Object Voverriding_local_map
;
117 Lisp_Object Qcurrent_input_method
, Qactivate_input_method
;
120 /* Put minibuf on currently selected frame's minibuffer.
121 We do this whenever the user starts a new minibuffer
122 or when a minibuffer exits. */
125 choose_minibuf_frame ()
127 if (selected_frame
!= 0
128 && !EQ (minibuf_window
, selected_frame
->minibuffer_window
))
130 /* I don't think that any frames may validly have a null minibuffer
132 if (NILP (selected_frame
->minibuffer_window
))
135 Fset_window_buffer (selected_frame
->minibuffer_window
,
136 XWINDOW (minibuf_window
)->buffer
);
137 minibuf_window
= selected_frame
->minibuffer_window
;
140 /* Make sure no other frame has a minibuffer as its selected window,
141 because the text would not be displayed in it, and that would be
142 confusing. Only allow the selected frame to do this,
143 and that only if the minibuffer is active. */
145 Lisp_Object tail
, frame
;
147 FOR_EACH_FRAME (tail
, frame
)
148 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame
))))
149 && !(XFRAME (frame
) == selected_frame
150 && minibuf_level
> 0))
151 Fset_frame_selected_window (frame
, Fframe_first_window (frame
));
156 choose_minibuf_frame_1 (ignore
)
159 choose_minibuf_frame ();
163 DEFUN ("set-minibuffer-window", Fset_minibuffer_window
,
164 Sset_minibuffer_window
, 1, 1, 0,
165 "Specify which minibuffer window to use for the minibuffer.\n\
166 This effects where the minibuffer is displayed if you put text in it\n\
167 without invoking the usual minibuffer commands.")
171 CHECK_WINDOW (window
, 1);
172 if (! MINI_WINDOW_P (XWINDOW (window
)))
173 error ("Window is not a minibuffer window");
175 minibuf_window
= window
;
181 /* Actual minibuffer invocation. */
183 static Lisp_Object
read_minibuf_unwind ();
184 Lisp_Object
get_minibuffer ();
185 static Lisp_Object
read_minibuf ();
187 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
188 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
189 prompting with PROMPT (a string), using history list HISTVAR
190 with initial position HISTPOS. (BACKUP_N should be <= 0.)
192 Normally return the result as a string (the text that was read),
193 but if EXPFLAG is nonzero, read it and return the object read.
194 If HISTVAR is given, save the value read on that history only if it doesn't
195 match the front of that history list exactly. The value is pushed onto
196 the list as the string that was read.
198 DEFALT specifies te default value for the sake of history commands.
200 If ALLOW_PROPS is nonzero, we do not throw away text properties.
202 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
203 current input method. */
206 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
207 histvar
, histpos
, defalt
, allow_props
, inherit_input_method
)
211 Lisp_Object backup_n
;
216 int inherit_input_method
;
219 int count
= specpdl_ptr
- specpdl
;
220 Lisp_Object mini_frame
, ambient_dir
, minibuffer
, input_method
;
221 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
222 Lisp_Object enable_multibyte
;
224 specbind (Qminibuffer_default
, defalt
);
226 single_kboard_state ();
229 ambient_dir
= current_buffer
->directory
;
231 enable_multibyte
= Qnil
;
233 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
234 store them away before we can GC. Don't need to protect
235 BACKUP_N because we use the value only if it is an integer. */
236 GCPRO5 (map
, initial
, val
, ambient_dir
, input_method
);
238 if (!STRINGP (prompt
))
239 prompt
= build_string ("");
241 if (!enable_recursive_minibuffers
242 && minibuf_level
> 0)
244 if (EQ (selected_window
, minibuf_window
))
245 error ("Command attempted to use minibuffer while in minibuffer");
247 /* If we're in another window, cancel the minibuffer that's active. */
249 build_string ("Command attempted to use minibuffer while in minibuffer"));
252 /* Choose the minibuffer window and frame, and take action on them. */
254 choose_minibuf_frame ();
256 record_unwind_protect (choose_minibuf_frame_1
, Qnil
);
258 record_unwind_protect (Fset_window_configuration
,
259 Fcurrent_window_configuration (Qnil
));
261 /* If the minibuffer window is on a different frame, save that
262 frame's configuration too. */
263 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
264 if (XFRAME (mini_frame
) != selected_frame
)
265 record_unwind_protect (Fset_window_configuration
,
266 Fcurrent_window_configuration (mini_frame
));
268 /* If the minibuffer is on an iconified or invisible frame,
269 make it visible now. */
270 Fmake_frame_visible (mini_frame
);
272 if (minibuffer_auto_raise
)
273 Fraise_frame (mini_frame
);
275 /* We have to do this after saving the window configuration
276 since that is what restores the current buffer. */
278 /* Arrange to restore a number of minibuffer-related variables.
279 We could bind each variable separately, but that would use lots of
282 = Fcons (Voverriding_local_map
,
283 Fcons (minibuf_window
, minibuf_save_list
));
285 = Fcons (minibuf_prompt
,
286 Fcons (make_number (minibuf_prompt_width
),
288 Fcons (Vcurrent_prefix_arg
,
289 Fcons (Vminibuffer_history_position
,
290 Fcons (Vminibuffer_history_variable
,
291 minibuf_save_list
))))));
293 record_unwind_protect (read_minibuf_unwind
, Qnil
);
296 /* Now that we can restore all those variables, start changing them. */
298 minibuf_prompt_width
= 0; /* xdisp.c puts in the right value. */
299 minibuf_prompt
= Fcopy_sequence (prompt
);
300 Vminibuffer_history_position
= histpos
;
301 Vminibuffer_history_variable
= histvar
;
302 Vhelp_form
= Vminibuffer_help_form
;
304 if (inherit_input_method
)
306 /* `current-input-method' is buffer local. So, remeber it in
307 INPUT_METHOD before changing the current buffer. */
308 input_method
= Fsymbol_value (Qcurrent_input_method
);
309 enable_multibyte
= current_buffer
->enable_multibyte_characters
;
312 /* Switch to the minibuffer. */
314 minibuffer
= get_minibuffer (minibuf_level
);
315 Fset_buffer (minibuffer
);
317 /* The current buffer's default directory is usually the right thing
318 for our minibuffer here. However, if you're typing a command at
319 a minibuffer-only frame when minibuf_level is zero, then buf IS
320 the current_buffer, so reset_buffer leaves buf's default
321 directory unchanged. This is a bummer when you've just started
322 up Emacs and buf's default directory is Qnil. Here's a hack; can
323 you think of something better to do? Find another buffer with a
324 better directory, and use that one instead. */
325 if (STRINGP (ambient_dir
))
326 current_buffer
->directory
= ambient_dir
;
329 Lisp_Object buf_list
;
331 for (buf_list
= Vbuffer_alist
;
333 buf_list
= XCONS (buf_list
)->cdr
)
335 Lisp_Object other_buf
;
337 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
338 if (STRINGP (XBUFFER (other_buf
)->directory
))
340 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
346 if (XFRAME (mini_frame
) != selected_frame
)
347 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
349 Vminibuf_scroll_window
= selected_window
;
350 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
351 Fselect_window (minibuf_window
);
352 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
354 Fmake_local_variable (Qprint_escape_newlines
);
355 print_escape_newlines
= 1;
357 /* Erase the buffer. */
359 int count1
= specpdl_ptr
- specpdl
;
360 specbind (Qinhibit_read_only
, Qt
);
362 unbind_to (count1
, Qnil
);
365 /* Put in the initial input. */
368 Finsert (1, &initial
);
369 if (!NILP (backup_n
) && INTEGERP (backup_n
))
370 Fgoto_char (make_number (PT
+ XFASTINT (backup_n
)));
373 echo_area_glyphs
= 0;
374 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
375 previous_echo_glyphs
= 0;
377 current_buffer
->keymap
= map
;
379 /* Turn on an input method stored in INPUT_METHOD if any. */
380 if (STRINGP (input_method
) && !NILP (Ffboundp (Qactivate_input_method
)))
381 call1 (Qactivate_input_method
, input_method
);
383 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
384 if (inherit_input_method
)
385 current_buffer
->enable_multibyte_characters
= enable_multibyte
;
387 /* Run our hook, but not if it is empty.
388 (run-hooks would do nothing if it is empty,
389 but it's important to save time here in the usual case). */
390 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
391 && !NILP (Vrun_hooks
))
392 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
394 /* ??? MCC did redraw_screen here if switching screens. */
397 /* If cursor is on the minibuffer line,
398 show the user we have exited by putting it in column 0. */
399 if ((FRAME_CURSOR_Y (selected_frame
)
400 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
403 FRAME_CURSOR_X (selected_frame
)
404 = FRAME_LEFT_SCROLL_BAR_WIDTH (selected_frame
);
405 update_frame (selected_frame
, 1, 1);
408 /* Make minibuffer contents into a string. */
409 Fset_buffer (minibuffer
);
410 val
= make_buffer_string (1, Z
, allow_props
);
411 #if 0 /* make_buffer_string should handle the gap. */
412 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
415 /* VAL is the string of minibuffer text. */
417 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (defalt
))
420 last_minibuf_string
= val
;
422 /* Add the value to the appropriate history list unless it is empty. */
423 if (XSTRING (val
)->size
!= 0
424 && SYMBOLP (Vminibuffer_history_variable
)
425 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
427 /* If the caller wanted to save the value read on a history list,
428 then do so if the value is not already the front of the list. */
430 histval
= Fsymbol_value (Vminibuffer_history_variable
);
432 /* The value of the history variable must be a cons or nil. Other
433 values are unacceptable. We silently ignore these values. */
436 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
440 histval
= Fcons (last_minibuf_string
, histval
);
441 Fset (Vminibuffer_history_variable
, histval
);
443 /* Truncate if requested. */
444 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
445 if (NILP (length
)) length
= Vhistory_length
;
446 if (INTEGERP (length
))
448 if (XINT (length
) <= 0)
449 Fset (Vminibuffer_history_variable
, Qnil
);
454 temp
= Fnthcdr (Fsub1 (length
), histval
);
455 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
461 /* If Lisp form desired instead of string, parse it. */
464 Lisp_Object expr_and_pos
;
467 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
468 /* Ignore trailing whitespace; any other trailing junk is an error. */
469 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
470 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
471 error ("Trailing garbage following expression");
472 val
= Fcar (expr_and_pos
);
475 /* The appropriate frame will get selected
476 in set-window-configuration. */
477 RETURN_UNGCPRO (unbind_to (count
, val
));
480 /* Return a buffer to be used as the minibuffer at depth `depth'.
481 depth = 0 is the lowest allowed argument, and that is the value
482 used for nonrecursive minibuffer invocations */
485 get_minibuffer (depth
)
488 Lisp_Object tail
, num
, buf
;
490 extern Lisp_Object
nconc2 ();
492 XSETFASTINT (num
, depth
);
493 tail
= Fnthcdr (num
, Vminibuffer_list
);
496 tail
= Fcons (Qnil
, Qnil
);
497 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
500 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
502 sprintf (name
, " *Minibuf-%d*", depth
);
503 buf
= Fget_buffer_create (build_string (name
));
505 /* Although the buffer's name starts with a space, undo should be
507 Fbuffer_enable_undo (buf
);
509 XCONS (tail
)->car
= buf
;
513 int count
= specpdl_ptr
- specpdl
;
515 reset_buffer (XBUFFER (buf
));
516 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
518 Fkill_all_local_variables ();
519 unbind_to (count
, Qnil
);
525 /* This function is called on exiting minibuffer, whether normally or not,
526 and it restores the current window, buffer, etc. */
529 read_minibuf_unwind (data
)
532 Lisp_Object old_deactivate_mark
;
535 /* We are exiting the minibuffer one way or the other,
537 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
538 && !NILP (Vrun_hooks
))
539 safe_run_hooks (Qminibuffer_exit_hook
);
541 /* If this was a recursive minibuffer,
542 tie the minibuffer window back to the outer level minibuffer buffer. */
545 window
= minibuf_window
;
546 /* To keep things predictable, in case it matters, let's be in the minibuffer
547 when we reset the relevant variables. */
548 Fset_buffer (XWINDOW (window
)->buffer
);
550 /* Restore prompt, etc, from outer minibuffer level. */
551 minibuf_prompt
= Fcar (minibuf_save_list
);
552 minibuf_save_list
= Fcdr (minibuf_save_list
);
553 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
554 minibuf_save_list
= Fcdr (minibuf_save_list
);
555 Vhelp_form
= Fcar (minibuf_save_list
);
556 minibuf_save_list
= Fcdr (minibuf_save_list
);
557 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
558 minibuf_save_list
= Fcdr (minibuf_save_list
);
559 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
560 minibuf_save_list
= Fcdr (minibuf_save_list
);
561 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
562 minibuf_save_list
= Fcdr (minibuf_save_list
);
563 Voverriding_local_map
= Fcar (minibuf_save_list
);
564 minibuf_save_list
= Fcdr (minibuf_save_list
);
566 temp
= Fcar (minibuf_save_list
);
567 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
568 minibuf_window
= temp
;
570 minibuf_save_list
= Fcdr (minibuf_save_list
);
572 /* Erase the minibuffer we were using at this level. */
574 int count
= specpdl_ptr
- specpdl
;
575 /* Prevent error in erase-buffer. */
576 specbind (Qinhibit_read_only
, Qt
);
577 old_deactivate_mark
= Vdeactivate_mark
;
579 Vdeactivate_mark
= old_deactivate_mark
;
580 unbind_to (count
, Qnil
);
583 /* Make sure minibuffer window is erased, not ignored. */
584 windows_or_buffers_changed
++;
585 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
586 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
592 /* This comment supplies the doc string for read-from-minibuffer,
593 for make-docfile to see. We cannot put this in the real DEFUN
594 due to limits in the Unix cpp.
596 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
597 "Read a string from the minibuffer, prompting with string PROMPT.\n\
598 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
599 to be inserted into the minibuffer before reading input.\n\
600 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
601 is STRING, but point is placed at position POSITION in the minibuffer.\n\
602 Third arg KEYMAP is a keymap to use whilst reading;\n\
603 if omitted or nil, the default is `minibuffer-local-map'.\n\
604 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
605 and return that object:\n\
606 in other words, do `(car (read-from-string INPUT-STRING))'\n\
607 Fifth arg HIST, if non-nil, specifies a history list\n\
608 and optionally the initial position in the list.\n\
609 It can be a symbol, which is the history list variable to use,\n\
610 or it can be a cons cell (HISTVAR . HISTPOS).\n\
611 In that case, HISTVAR is the history list variable to use,\n\
612 and HISTPOS is the initial position (the position in the list\n\
613 which INITIAL-CONTENTS corresponds to).\n\
614 Positions are counted starting from 1 at the beginning of the list.\n\
615 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
616 for history commands, and as the value to return if the user enters\n\
618 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
619 the current input method and the setting of enable-multibyte-characters.\n\
620 If the variable `minibuffer-allow-text-properties is non-nil,\n\
621 then the string which is returned includes whatever text properties\n\
622 were present in the minibuffer. Otherwise the value has no text properties.")
623 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
626 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
627 0 /* See immediately above */)
628 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
629 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
630 Lisp_Object inherit_input_method
;
633 Lisp_Object histvar
, histpos
, position
, val
;
638 CHECK_STRING (prompt
, 0);
639 if (!NILP (initial_contents
))
641 if (CONSP (initial_contents
))
643 position
= Fcdr (initial_contents
);
644 initial_contents
= Fcar (initial_contents
);
646 CHECK_STRING (initial_contents
, 1);
647 if (!NILP (position
))
649 CHECK_NUMBER (position
, 0);
650 /* Convert to distance from end of input. */
651 if (XINT (position
) < 1)
652 /* A number too small means the beginning of the string. */
653 pos
= - XSTRING (initial_contents
)->size
;
655 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
660 keymap
= Vminibuffer_local_map
;
662 keymap
= get_keymap (keymap
);
671 histvar
= Fcar_safe (hist
);
672 histpos
= Fcdr_safe (hist
);
675 histvar
= Qminibuffer_history
;
677 XSETFASTINT (histpos
, 0);
679 GCPRO1 (default_value
);
680 val
= read_minibuf (keymap
, initial_contents
, prompt
,
681 make_number (pos
), !NILP (read
),
682 histvar
, histpos
, default_value
,
683 minibuffer_allow_text_properties
,
684 !NILP (inherit_input_method
));
689 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
690 "Return a Lisp object read using the minibuffer.\n\
691 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
692 is a string to insert in the minibuffer before reading.")
693 (prompt
, initial_contents
)
694 Lisp_Object prompt
, initial_contents
;
696 CHECK_STRING (prompt
, 0);
697 if (!NILP (initial_contents
))
698 CHECK_STRING (initial_contents
, 1);
699 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
700 prompt
, Qnil
, 1, Qminibuffer_history
,
701 make_number (0), Qnil
, 0, 0);
704 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
705 "Return value of Lisp expression read using the minibuffer.\n\
706 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
707 is a string to insert in the minibuffer before reading.")
708 (prompt
, initial_contents
)
709 Lisp_Object prompt
, initial_contents
;
711 return Feval (Fread_minibuffer (prompt
, initial_contents
));
714 /* Functions that use the minibuffer to read various things. */
716 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
717 "Read a string from the minibuffer, prompting with string PROMPT.\n\
718 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
719 The third arg HISTORY, if non-nil, specifies a history list\n\
720 and optionally the initial position in the list.\n\
721 See `read-from-minibuffer' for details of HISTORY argument.\n\
722 Fourth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
723 the current input method and the setting of enable-multibyte-characters.")
724 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
725 Lisp_Object prompt
, initial_input
, history
, default_value
;
726 Lisp_Object inherit_input_method
;
728 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
729 Qnil
, history
, default_value
,
730 inherit_input_method
);
733 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
734 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
735 Prompt with PROMPT, and provide INIT as an initial value of the input string.\n\
736 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
737 the current input method and the setting of enable-multibyte-characters.")
738 (prompt
, init
, inherit_input_method
)
739 Lisp_Object prompt
, init
, inherit_input_method
;
741 CHECK_STRING (prompt
, 0);
743 CHECK_STRING (init
, 1);
745 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
,
746 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
747 !NILP (inherit_input_method
));
750 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
751 "Read the name of a command and return as a symbol.\n\
752 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
753 (prompt
, default_value
)
754 Lisp_Object prompt
, default_value
;
756 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
757 Qnil
, Qnil
, default_value
, Qnil
),
762 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
763 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
764 Prompts with PROMPT.")
768 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
773 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
774 "Read the name of a user variable and return it as a symbol.\n\
775 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
776 A user variable is one whose documentation starts with a `*' character.")
777 (prompt
, default_value
)
778 Lisp_Object prompt
, default_value
;
780 return Fintern (Fcompleting_read (prompt
, Vobarray
,
781 Quser_variable_p
, Qt
,
782 Qnil
, Qnil
, default_value
, Qnil
),
786 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
787 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
788 Prompts with PROMPT.\n\
789 Optional second arg DEF is value to return if user enters an empty line.\n\
790 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
791 (prompt
, def
, require_match
)
792 Lisp_Object prompt
, def
, require_match
;
798 def
= XBUFFER (def
)->name
;
801 args
[0] = build_string ("%s(default %s) ");
804 prompt
= Fformat (3, args
);
806 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
807 require_match
, Qnil
, Qnil
, def
, Qnil
);
810 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
811 "Return common substring of all completions of STRING in ALIST.\n\
812 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
813 All that match are compared together; the longest initial sequence\n\
814 common to all matches is returned as a string.\n\
815 If there is no match at all, nil is returned.\n\
816 For an exact match, t is returned.\n\
818 ALIST can be an obarray instead of an alist.\n\
819 Then the print names of all symbols in the obarray are the possible matches.\n\
821 ALIST can also be a function to do the completion itself.\n\
822 It receives three arguments: the values STRING, PREDICATE and nil.\n\
823 Whatever it returns becomes the value of `try-completion'.\n\
825 If optional third argument PREDICATE is non-nil,\n\
826 it is used to test each possible match.\n\
827 The match is a candidate only if PREDICATE returns non-nil.\n\
828 The argument given to PREDICATE is the alist element\n\
829 or the symbol from the obarray.")
830 (string
, alist
, predicate
)
831 Lisp_Object string
, alist
, predicate
;
833 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
835 int compare
, matchsize
;
836 int list
= CONSP (alist
) || NILP (alist
);
839 Lisp_Object bucket
, zero
, end
, tem
;
840 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
842 CHECK_STRING (string
, 0);
843 if (!list
&& !VECTORP (alist
))
844 return call3 (alist
, string
, predicate
, Qnil
);
848 /* If ALIST is not a list, set TAIL just for gc pro. */
853 obsize
= XVECTOR (alist
)->size
;
854 bucket
= XVECTOR (alist
)->contents
[index
];
859 /* Get the next element of the alist or obarray. */
860 /* Exit the loop if the elements are all used up. */
861 /* elt gets the alist element or symbol.
862 eltstring gets the name to check as a completion. */
869 eltstring
= Fcar (elt
);
874 if (XFASTINT (bucket
) != 0)
877 eltstring
= Fsymbol_name (elt
);
878 if (XSYMBOL (bucket
)->next
)
879 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
881 XSETFASTINT (bucket
, 0);
883 else if (++index
>= obsize
)
887 bucket
= XVECTOR (alist
)->contents
[index
];
892 /* Is this element a possible completion? */
894 if (STRINGP (eltstring
)
895 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
896 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
897 XSTRING (string
)->size
))
902 XSETFASTINT (zero
, 0);
904 /* Ignore this element if it fails to match all the regexps. */
905 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
906 regexps
= XCONS (regexps
)->cdr
)
908 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
915 /* Ignore this element if there is a predicate
916 and the predicate doesn't like it. */
918 if (!NILP (predicate
))
920 if (EQ (predicate
, Qcommandp
))
921 tem
= Fcommandp (elt
);
924 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
925 tem
= call1 (predicate
, elt
);
928 if (NILP (tem
)) continue;
931 /* Update computation of how much all possible completions match */
934 if (NILP (bestmatch
))
935 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
938 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
939 matchsize
= scmp (XSTRING (bestmatch
)->data
,
940 XSTRING (eltstring
)->data
,
944 if (completion_ignore_case
)
946 /* If this is an exact match except for case,
947 use it as the best match rather than one that is not an
948 exact match. This way, we get the case pattern
949 of the actual match. */
950 if ((matchsize
== XSTRING (eltstring
)->size
951 && matchsize
< XSTRING (bestmatch
)->size
)
953 /* If there is more than one exact match ignoring case,
954 and one of them is exact including case,
956 /* If there is no exact match ignoring case,
957 prefer a match that does not change the case
959 ((matchsize
== XSTRING (eltstring
)->size
)
961 (matchsize
== XSTRING (bestmatch
)->size
)
962 && !bcmp (XSTRING (eltstring
)->data
,
963 XSTRING (string
)->data
, XSTRING (string
)->size
)
964 && bcmp (XSTRING (bestmatch
)->data
,
965 XSTRING (string
)->data
, XSTRING (string
)->size
)))
966 bestmatch
= eltstring
;
968 bestmatchsize
= matchsize
;
973 if (NILP (bestmatch
))
974 return Qnil
; /* No completions found */
975 /* If we are ignoring case, and there is no exact match,
976 and no additional text was supplied,
977 don't change the case of what the user typed. */
978 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
979 && XSTRING (bestmatch
)->size
> bestmatchsize
)
982 /* Return t if the supplied string is an exact match (counting case);
983 it does not require any change to be made. */
984 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
985 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
989 XSETFASTINT (zero
, 0); /* Else extract the part in which */
990 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
991 return Fsubstring (bestmatch
, zero
, end
);
994 /* Compare exactly LEN chars of strings at S1 and S2,
995 ignoring case if appropriate.
996 Return -1 if strings match,
997 else number of chars that match at the beginning. */
1001 register unsigned char *s1
, *s2
;
1004 register int l
= len
;
1005 register unsigned char *start
= s1
;
1007 if (completion_ignore_case
)
1009 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1014 while (l
&& *s1
++ == *s2
++)
1021 int match
= len
- l
;
1023 /* Now *--S1 is the unmatching byte. If it is in the middle of
1024 multi-byte form, we must say that the multi-byte character
1025 there doesn't match. */
1026 while (match
&& *--s1
>= 0xA0) match
--;
1031 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1032 "Search for partial matches to STRING in ALIST.\n\
1033 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1034 The value is a list of all the strings from ALIST that match.\n\
1036 ALIST can be an obarray instead of an alist.\n\
1037 Then the print names of all symbols in the obarray are the possible matches.\n\
1039 ALIST can also be a function to do the completion itself.\n\
1040 It receives three arguments: the values STRING, PREDICATE and t.\n\
1041 Whatever it returns becomes the value of `all-completion'.\n\
1043 If optional third argument PREDICATE is non-nil,\n\
1044 it is used to test each possible match.\n\
1045 The match is a candidate only if PREDICATE returns non-nil.\n\
1046 The argument given to PREDICATE is the alist element\n\
1047 or the symbol from the obarray.\n\
1049 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1050 strings in ALIST that start with a space\n\
1051 are ignored unless STRING itself starts with a space.")
1052 (string
, alist
, predicate
, hide_spaces
)
1053 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1055 Lisp_Object tail
, elt
, eltstring
;
1056 Lisp_Object allmatches
;
1057 int list
= CONSP (alist
) || NILP (alist
);
1059 Lisp_Object bucket
, tem
;
1060 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1062 CHECK_STRING (string
, 0);
1063 if (!list
&& !VECTORP (alist
))
1065 return call3 (alist
, string
, predicate
, Qt
);
1069 /* If ALIST is not a list, set TAIL just for gc pro. */
1074 obsize
= XVECTOR (alist
)->size
;
1075 bucket
= XVECTOR (alist
)->contents
[index
];
1080 /* Get the next element of the alist or obarray. */
1081 /* Exit the loop if the elements are all used up. */
1082 /* elt gets the alist element or symbol.
1083 eltstring gets the name to check as a completion. */
1090 eltstring
= Fcar (elt
);
1095 if (XFASTINT (bucket
) != 0)
1098 eltstring
= Fsymbol_name (elt
);
1099 if (XSYMBOL (bucket
)->next
)
1100 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1102 XSETFASTINT (bucket
, 0);
1104 else if (++index
>= obsize
)
1108 bucket
= XVECTOR (alist
)->contents
[index
];
1113 /* Is this element a possible completion? */
1115 if (STRINGP (eltstring
)
1116 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1117 /* If HIDE_SPACES, reject alternatives that start with space
1118 unless the input starts with space. */
1119 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
1120 || XSTRING (eltstring
)->data
[0] != ' '
1121 || NILP (hide_spaces
))
1122 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1123 XSTRING (string
)->size
))
1126 Lisp_Object regexps
;
1128 XSETFASTINT (zero
, 0);
1130 /* Ignore this element if it fails to match all the regexps. */
1131 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1132 regexps
= XCONS (regexps
)->cdr
)
1134 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1138 if (CONSP (regexps
))
1141 /* Ignore this element if there is a predicate
1142 and the predicate doesn't like it. */
1144 if (!NILP (predicate
))
1146 if (EQ (predicate
, Qcommandp
))
1147 tem
= Fcommandp (elt
);
1150 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1151 tem
= call1 (predicate
, elt
);
1154 if (NILP (tem
)) continue;
1156 /* Ok => put it on the list. */
1157 allmatches
= Fcons (eltstring
, allmatches
);
1161 return Fnreverse (allmatches
);
1164 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1165 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1166 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1168 /* This comment supplies the doc string for completing-read,
1169 for make-docfile to see. We cannot put this in the real DEFUN
1170 due to limits in the Unix cpp.
1172 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1173 "Read a string in the minibuffer, with completion.\n\
1174 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1175 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1176 PREDICATE limits completion to a subset of TABLE.\n\
1177 See `try-completion' and `all-completions' for more details
1178 on completion, TABLE, and PREDICATE.\n\
1180 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1181 the input is (or completes to) an element of TABLE or is null.\n\
1182 If it is also not t, Return does not exit if it does non-null completion.\n\
1183 If the input is null, `completing-read' returns an empty string,\n\
1184 regardless of the value of REQUIRE-MATCH.\n\
1186 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1187 If it is (STRING . POSITION), the initial input\n\
1188 is STRING, but point is placed POSITION characters into the string.\n\
1189 HIST, if non-nil, specifies a history list\n\
1190 and optionally the initial position in the list.\n\
1191 It can be a symbol, which is the history list variable to use,\n\
1192 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1193 In that case, HISTVAR is the history list variable to use,\n\
1194 and HISTPOS is the initial position (the position in the list\n\
1195 which INITIAL-CONTENTS corresponds to).\n\
1196 Positions are counted starting from 1 at the beginning of the list.\n\
1197 DEF, if non-nil, is the default value.\n\
1199 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1200 the current input method and the setting of enable-multibyte-characters.\n\
1202 Completion ignores case if the ambient value of\n\
1203 `completion-ignore-case' is non-nil."
1205 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1206 0 /* See immediately above */)
1207 (prompt
, table
, predicate
, require_match
, init
, hist
, def
, inherit_input_method
)
1208 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
, def
;
1209 Lisp_Object inherit_input_method
;
1211 Lisp_Object val
, histvar
, histpos
, position
;
1213 int count
= specpdl_ptr
- specpdl
;
1214 struct gcpro gcpro1
;
1215 int disable_multibyte
= EQ (table
, Qread_file_name_internal
);
1219 specbind (Qminibuffer_completion_table
, table
);
1220 specbind (Qminibuffer_completion_predicate
, predicate
);
1221 specbind (Qminibuffer_completion_confirm
,
1222 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1223 last_exact_completion
= Qnil
;
1230 position
= Fcdr (init
);
1233 CHECK_STRING (init
, 0);
1234 if (!NILP (position
))
1236 CHECK_NUMBER (position
, 0);
1237 /* Convert to distance from end of input. */
1238 pos
= XINT (position
) - XSTRING (init
)->size
;
1249 histvar
= Fcar_safe (hist
);
1250 histpos
= Fcdr_safe (hist
);
1253 histvar
= Qminibuffer_history
;
1255 XSETFASTINT (histpos
, 0);
1257 val
= read_minibuf (NILP (require_match
)
1258 ? Vminibuffer_local_completion_map
1259 : Vminibuffer_local_must_match_map
,
1260 init
, prompt
, make_number (pos
), 0,
1261 histvar
, histpos
, def
, 0,
1262 !NILP (inherit_input_method
));
1263 RETURN_UNGCPRO (unbind_to (count
, val
));
1266 Lisp_Object
Fminibuffer_completion_help ();
1267 Lisp_Object
assoc_for_completion ();
1268 /* A subroutine of Fintern_soft. */
1269 extern Lisp_Object
oblookup ();
1272 /* Test whether TXT is an exact completion. */
1274 test_completion (txt
)
1279 if (CONSP (Vminibuffer_completion_table
)
1280 || NILP (Vminibuffer_completion_table
))
1281 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1282 else if (VECTORP (Vminibuffer_completion_table
))
1284 /* Bypass intern-soft as that loses for nil */
1285 tem
= oblookup (Vminibuffer_completion_table
,
1286 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1289 else if (!NILP (Vminibuffer_completion_predicate
))
1290 return call1 (Vminibuffer_completion_predicate
, tem
);
1295 return call3 (Vminibuffer_completion_table
, txt
,
1296 Vminibuffer_completion_predicate
, Qlambda
);
1300 * 0 no possible completion
1301 * 1 was already an exact and unique completion
1302 * 3 was already an exact completion
1303 * 4 completed to an exact completion
1304 * 5 some completion happened
1305 * 6 no completion happened
1310 Lisp_Object completion
, tem
;
1313 struct gcpro gcpro1
, gcpro2
;
1315 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1316 Vminibuffer_completion_predicate
);
1317 last
= last_exact_completion
;
1318 last_exact_completion
= Qnil
;
1320 GCPRO2 (completion
, last
);
1322 if (NILP (completion
))
1325 temp_echo_area_glyphs (" [No match]");
1330 if (EQ (completion
, Qt
)) /* exact and unique match */
1337 tem
= Fstring_equal (completion
, Fbuffer_string());
1338 if (completedp
= NILP (tem
))
1340 Ferase_buffer (); /* Some completion happened */
1341 Finsert (1, &completion
);
1344 /* It did find a match. Do we match some possibility exactly now? */
1345 tem
= test_completion (Fbuffer_string ());
1348 /* not an exact match */
1353 Fminibuffer_completion_help ();
1355 temp_echo_area_glyphs (" [Next char not unique]");
1358 else if (completedp
)
1363 /* If the last exact completion and this one were the same,
1364 it means we've already given a "Complete but not unique"
1365 message and the user's hit TAB again, so now we give him help. */
1366 last_exact_completion
= completion
;
1369 tem
= Fbuffer_string ();
1370 if (!NILP (Fequal (tem
, last
)))
1371 Fminibuffer_completion_help ();
1377 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1380 assoc_for_completion (key
, list
)
1381 register Lisp_Object key
;
1384 register Lisp_Object tail
;
1386 if (completion_ignore_case
)
1387 key
= Fupcase (key
);
1389 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1391 register Lisp_Object elt
, tem
, thiscar
;
1393 if (!CONSP (elt
)) continue;
1394 thiscar
= Fcar (elt
);
1395 if (!STRINGP (thiscar
))
1397 if (completion_ignore_case
)
1398 thiscar
= Fupcase (thiscar
);
1399 tem
= Fequal (thiscar
, key
);
1400 if (!NILP (tem
)) return elt
;
1406 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1407 "Complete the minibuffer contents as far as possible.\n\
1408 Return nil if there is no valid completion, else t.\n\
1409 If no characters can be completed, display a list of possible completions.\n\
1410 If you repeat this command after it displayed such a list,\n\
1411 scroll the window of possible completions.")
1415 Lisp_Object window
, tem
;
1417 /* If the previous command was not this, then mark the completion
1419 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1420 Vminibuf_scroll_window
= Qnil
;
1422 window
= Vminibuf_scroll_window
;
1423 /* If there's a fresh completion window with a live buffer,
1424 and this command is repeated, scroll that window. */
1425 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1426 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1428 struct buffer
*obuf
= current_buffer
;
1430 Fset_buffer (XWINDOW (window
)->buffer
);
1431 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1433 /* If end is in view, scroll up to the beginning. */
1434 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1436 /* Else scroll down one screen. */
1437 Fscroll_other_window (Qnil
);
1439 set_buffer_internal (obuf
);
1443 i
= do_completion ();
1450 temp_echo_area_glyphs (" [Sole completion]");
1454 temp_echo_area_glyphs (" [Complete, but not unique]");
1461 /* Subroutines of Fminibuffer_complete_and_exit. */
1463 /* This one is called by internal_condition_case to do the real work. */
1466 complete_and_exit_1 ()
1468 return make_number (do_completion ());
1471 /* This one is called by internal_condition_case if an error happens.
1472 Pretend the current value is an exact match. */
1475 complete_and_exit_2 (ignore
)
1478 return make_number (1);
1481 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1482 Sminibuffer_complete_and_exit
, 0, 0, "",
1483 "If the minibuffer contents is a valid completion then exit.\n\
1484 Otherwise try to complete it. If completion leads to a valid completion,\n\
1485 a repetition of this command will exit.")
1491 /* Allow user to specify null string */
1495 if (!NILP (test_completion (Fbuffer_string ())))
1498 /* Call do_completion, but ignore errors. */
1499 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1500 complete_and_exit_2
);
1510 if (!NILP (Vminibuffer_completion_confirm
))
1512 temp_echo_area_glyphs (" [Confirm]");
1522 Fthrow (Qexit
, Qnil
);
1526 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1528 "Complete the minibuffer contents at most a single word.\n\
1529 After one word is completed as much as possible, a space or hyphen\n\
1530 is added, provided that matches some possible completion.\n\
1531 Return nil if there is no valid completion, else t.")
1534 Lisp_Object completion
, tem
;
1536 register unsigned char *completion_string
;
1537 struct gcpro gcpro1
, gcpro2
;
1539 /* We keep calling Fbuffer_string rather than arrange for GC to
1540 hold onto a pointer to one of the strings thus made. */
1542 completion
= Ftry_completion (Fbuffer_string (),
1543 Vminibuffer_completion_table
,
1544 Vminibuffer_completion_predicate
);
1545 if (NILP (completion
))
1548 temp_echo_area_glyphs (" [No match]");
1551 if (EQ (completion
, Qt
))
1554 #if 0 /* How the below code used to look, for reference. */
1555 tem
= Fbuffer_string ();
1556 b
= XSTRING (tem
)->data
;
1557 i
= ZV
- 1 - XSTRING (completion
)->size
;
1558 p
= XSTRING (completion
)->data
;
1560 0 <= scmp (b
, p
, ZV
- 1))
1563 /* Set buffer to longest match of buffer tail and completion head. */
1564 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1566 del_range (1, i
+ 1);
1569 #else /* Rewritten code */
1571 register unsigned char *buffer_string
;
1572 int buffer_length
, completion_length
;
1574 CHECK_STRING (completion
, 0);
1575 tem
= Fbuffer_string ();
1576 GCPRO2 (completion
, tem
);
1577 /* If reading a file name,
1578 expand any $ENVVAR refs in the buffer and in TEM. */
1579 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1581 Lisp_Object substituted
;
1582 substituted
= Fsubstitute_in_file_name (tem
);
1583 if (! EQ (substituted
, tem
))
1587 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1590 buffer_string
= XSTRING (tem
)->data
;
1591 completion_string
= XSTRING (completion
)->data
;
1592 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1593 completion_length
= XSTRING (completion
)->size
;
1594 i
= buffer_length
- completion_length
;
1595 /* Mly: I don't understand what this is supposed to do AT ALL */
1597 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1599 /* Set buffer to longest match of buffer tail and completion head. */
1603 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1605 del_range (1, i
+ 1);
1610 #endif /* Rewritten code */
1613 /* If completion finds next char not unique,
1614 consider adding a space or a hyphen. */
1615 if (i
== XSTRING (completion
)->size
)
1617 GCPRO1 (completion
);
1618 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1619 Vminibuffer_completion_table
,
1620 Vminibuffer_completion_predicate
);
1627 GCPRO1 (completion
);
1629 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1630 Vminibuffer_completion_table
,
1631 Vminibuffer_completion_predicate
);
1639 /* Now find first word-break in the stuff found by completion.
1640 i gets index in string of where to stop completing. */
1644 completion_string
= XSTRING (completion
)->data
;
1645 for (; i
< XSTRING (completion
)->size
; i
+= len
)
1647 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i
,
1648 XSTRING (completion
)->size
- i
,
1650 if (SYNTAX (c
) != Sword
)
1658 /* If got no characters, print help for user. */
1663 Fminibuffer_completion_help ();
1667 /* Otherwise insert in minibuffer the chars we got */
1670 insert_from_string (completion
, 0, i
, 1);
1674 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1676 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1677 Each element may be just a symbol or string\n\
1678 or may be a list of two strings to be printed as if concatenated.\n\
1679 `standard-output' must be a buffer.\n\
1680 At the end, run the normal hook `completion-setup-hook'.\n\
1681 It can find the completion buffer in `standard-output'.")
1683 Lisp_Object completions
;
1685 Lisp_Object tail
, elt
;
1688 struct gcpro gcpro1
, gcpro2
;
1689 struct buffer
*old
= current_buffer
;
1692 /* Note that (when it matters) every variable
1693 points to a non-string that is pointed to by COMPLETIONS,
1694 except for ELT. ELT can be pointing to a string
1695 when terpri or Findent_to calls a change hook. */
1697 GCPRO2 (completions
, elt
);
1699 if (BUFFERP (Vstandard_output
))
1700 set_buffer_internal (XBUFFER (Vstandard_output
));
1702 if (NILP (completions
))
1703 write_string ("There are no possible completions of what you have typed.",
1707 write_string ("Possible completions are:", -1);
1708 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1712 Lisp_Object startpos
, endpos
;
1715 /* Compute the length of this element. */
1719 CHECK_STRING (tem
, 0);
1720 length
= XSTRING (tem
)->size
;
1722 tem
= Fcar (XCDR (elt
));
1723 CHECK_STRING (tem
, 0);
1724 length
+= XSTRING (tem
)->size
;
1728 CHECK_STRING (elt
, 0);
1729 length
= XSTRING (elt
)->size
;
1732 /* This does a bad job for narrower than usual windows.
1733 Sadly, the window it will appear in is not known
1734 until after the text has been made. */
1736 if (BUFFERP (Vstandard_output
))
1737 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1739 /* If the previous completion was very wide,
1740 or we have two on this line already,
1741 don't put another on the same line. */
1742 if (column
> 33 || first
1743 /* If this is really wide, don't put it second on a line. */
1744 || column
> 0 && length
> 45)
1749 /* Otherwise advance to column 35. */
1752 if (BUFFERP (Vstandard_output
))
1754 tem
= Findent_to (make_number (35), make_number (2));
1756 column
= XINT (tem
);
1762 write_string (" ", -1);
1765 while (column
< 35);
1769 if (BUFFERP (Vstandard_output
))
1771 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1772 Fset_text_properties (startpos
, endpos
,
1773 Qnil
, Vstandard_output
);
1776 /* Output this element and update COLUMN. */
1779 Fprinc (Fcar (elt
), Qnil
);
1780 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1787 /* If output is to a buffer, recompute COLUMN in a way
1788 that takes account of character widths. */
1789 if (BUFFERP (Vstandard_output
))
1791 tem
= Fcurrent_column ();
1792 column
= XINT (tem
);
1801 if (BUFFERP (Vstandard_output
))
1802 set_buffer_internal (old
);
1804 if (!NILP (Vrun_hooks
))
1805 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1810 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1812 "Display a list of possible completions of the current minibuffer contents.")
1815 Lisp_Object completions
;
1817 message ("Making completion list...");
1818 completions
= Fall_completions (Fbuffer_string (),
1819 Vminibuffer_completion_table
,
1820 Vminibuffer_completion_predicate
,
1822 echo_area_glyphs
= 0;
1824 if (NILP (completions
))
1827 temp_echo_area_glyphs (" [No completions]");
1830 internal_with_output_to_temp_buffer ("*Completions*",
1831 Fdisplay_completion_list
,
1832 Fsort (completions
, Qstring_lessp
));
1836 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1837 "Terminate minibuffer input.")
1840 if (INTEGERP (last_command_char
))
1841 internal_self_insert (last_command_char
, 0);
1845 Fthrow (Qexit
, Qnil
);
1848 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1849 "Terminate this minibuffer argument.")
1852 Fthrow (Qexit
, Qnil
);
1855 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1856 "Return current depth of activations of minibuffer, a nonnegative integer.")
1859 return make_number (minibuf_level
);
1862 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1863 "Return the prompt string of the currently-active minibuffer.\n\
1864 If no minibuffer is active, return nil.")
1867 return Fcopy_sequence (minibuf_prompt
);
1870 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1871 Sminibuffer_prompt_width
, 0, 0, 0,
1872 "Return the display width of the minibuffer prompt.")
1876 XSETFASTINT (width
, minibuf_prompt_width
);
1880 /* Temporarily display the string M at the end of the current
1881 minibuffer contents. This is used to display things like
1882 "[No Match]" when the user requests a completion for a prefix
1883 that has no possible completions, and other quick, unobtrusive
1887 temp_echo_area_glyphs (m
)
1892 Lisp_Object oinhibit
;
1893 oinhibit
= Vinhibit_quit
;
1895 /* Clear out any old echo-area message to make way for our new thing. */
1902 Fsit_for (make_number (2), Qnil
, Qnil
);
1903 del_range (osize
, ZV
);
1905 if (!NILP (Vquit_flag
))
1908 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1910 Vinhibit_quit
= oinhibit
;
1913 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
1915 "Temporarily display STRING at the end of the minibuffer.\n\
1916 The text is displayed for two seconds,\n\
1917 or until the next input event arrives, whichever comes first.")
1921 temp_echo_area_glyphs (XSTRING (string
)->data
);
1926 init_minibuf_once ()
1928 Vminibuffer_list
= Qnil
;
1929 staticpro (&Vminibuffer_list
);
1936 minibuf_prompt
= Qnil
;
1937 staticpro (&minibuf_prompt
);
1939 minibuf_save_list
= Qnil
;
1940 staticpro (&minibuf_save_list
);
1942 Qread_file_name_internal
= intern ("read-file-name-internal");
1943 staticpro (&Qread_file_name_internal
);
1945 Qminibuffer_default
= intern ("minibuffer-default");
1946 staticpro (&Qminibuffer_default
);
1947 Fset (Qminibuffer_default
, Qnil
);
1949 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1950 staticpro (&Qminibuffer_completion_table
);
1952 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1953 staticpro (&Qminibuffer_completion_confirm
);
1955 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1956 staticpro (&Qminibuffer_completion_predicate
);
1958 staticpro (&last_exact_completion
);
1959 last_exact_completion
= Qnil
;
1961 staticpro (&last_minibuf_string
);
1962 last_minibuf_string
= Qnil
;
1964 Quser_variable_p
= intern ("user-variable-p");
1965 staticpro (&Quser_variable_p
);
1967 Qminibuffer_history
= intern ("minibuffer-history");
1968 staticpro (&Qminibuffer_history
);
1970 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1971 staticpro (&Qminibuffer_setup_hook
);
1973 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1974 staticpro (&Qminibuffer_exit_hook
);
1976 Qhistory_length
= intern ("history-length");
1977 staticpro (&Qhistory_length
);
1979 Qcurrent_input_method
= intern ("current-input-method");
1980 staticpro (&Qcurrent_input_method
);
1982 Qactivate_input_method
= intern ("activate-input-method");
1983 staticpro (&Qactivate_input_method
);
1985 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1986 "Normal hook run just after entry to minibuffer.");
1987 Vminibuffer_setup_hook
= Qnil
;
1989 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1990 "Normal hook run just after exit from minibuffer.");
1991 Vminibuffer_exit_hook
= Qnil
;
1993 DEFVAR_LISP ("history-length", &Vhistory_length
,
1994 "*Maximum length for history lists before truncation takes place.\n\
1995 A number means that length; t means infinite. Truncation takes place\n\
1996 just after a new element is inserted. Setting the history-length\n\
1997 property of a history variable overrides this default.");
1998 XSETFASTINT (Vhistory_length
, 30);
2000 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
2001 "*Non-nil means automatically provide help for invalid completion input.");
2004 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2005 "Non-nil means don't consider case significant in completion.");
2006 completion_ignore_case
= 0;
2008 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2009 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2010 This variable makes a difference whenever the minibuffer window is active.");
2011 enable_recursive_minibuffers
= 0;
2013 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2014 "Alist or obarray used for completion in the minibuffer.\n\
2015 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2017 The value may alternatively be a function, which is given three arguments:\n\
2018 STRING, the current buffer contents;\n\
2019 PREDICATE, the predicate for filtering possible matches;\n\
2020 CODE, which says what kind of things to do.\n\
2021 CODE can be nil, t or `lambda'.\n\
2022 nil means to return the best completion of STRING, or nil if there is none.\n\
2023 t means to return a list of all possible completions of STRING.\n\
2024 `lambda' means to return t if STRING is a valid completion as it stands.");
2025 Vminibuffer_completion_table
= Qnil
;
2027 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2028 "Within call to `completing-read', this holds the PREDICATE argument.");
2029 Vminibuffer_completion_predicate
= Qnil
;
2031 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2032 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2033 Vminibuffer_completion_confirm
= Qnil
;
2035 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2036 "Value that `help-form' takes on inside the minibuffer.");
2037 Vminibuffer_help_form
= Qnil
;
2039 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2040 "History list symbol to add minibuffer values to.\n\
2041 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2043 (set minibuffer-history-variable\n\
2044 (cons STRING (symbol-value minibuffer-history-variable)))");
2045 XSETFASTINT (Vminibuffer_history_variable
, 0);
2047 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2048 "Current position of redoing in the history list.");
2049 Vminibuffer_history_position
= Qnil
;
2051 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2052 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2053 Some uses of the echo area also raise that frame (since they use it too).");
2054 minibuffer_auto_raise
= 0;
2056 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2057 "List of regexps that should restrict possible completions.");
2058 Vcompletion_regexp_list
= Qnil
;
2060 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2061 &minibuffer_allow_text_properties
,
2062 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2063 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2064 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2065 with completion; they always discard text properties.");
2066 minibuffer_allow_text_properties
= 0;
2068 defsubr (&Sset_minibuffer_window
);
2069 defsubr (&Sread_from_minibuffer
);
2070 defsubr (&Seval_minibuffer
);
2071 defsubr (&Sread_minibuffer
);
2072 defsubr (&Sread_string
);
2073 defsubr (&Sread_command
);
2074 defsubr (&Sread_variable
);
2075 defsubr (&Sread_buffer
);
2076 defsubr (&Sread_no_blanks_input
);
2077 defsubr (&Sminibuffer_depth
);
2078 defsubr (&Sminibuffer_prompt
);
2079 defsubr (&Sminibuffer_prompt_width
);
2081 defsubr (&Stry_completion
);
2082 defsubr (&Sall_completions
);
2083 defsubr (&Scompleting_read
);
2084 defsubr (&Sminibuffer_complete
);
2085 defsubr (&Sminibuffer_complete_word
);
2086 defsubr (&Sminibuffer_complete_and_exit
);
2087 defsubr (&Sdisplay_completion_list
);
2088 defsubr (&Sminibuffer_completion_help
);
2090 defsubr (&Sself_insert_and_exit
);
2091 defsubr (&Sexit_minibuffer
);
2093 defsubr (&Sminibuffer_message
);
2099 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2100 "abort-recursive-edit");
2101 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2103 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2106 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2107 "abort-recursive-edit");
2108 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2110 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2113 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2115 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2117 initial_define_key (Vminibuffer_local_ns_map
, '?',
2118 "self-insert-and-exit");
2120 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2121 "abort-recursive-edit");
2122 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2124 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2127 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2128 "minibuffer-complete");
2129 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2130 "minibuffer-complete-word");
2131 initial_define_key (Vminibuffer_local_completion_map
, '?',
2132 "minibuffer-completion-help");
2134 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2135 "abort-recursive-edit");
2136 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2137 "minibuffer-complete-and-exit");
2138 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2139 "minibuffer-complete-and-exit");
2140 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2141 "minibuffer-complete");
2142 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2143 "minibuffer-complete-word");
2144 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2145 "minibuffer-completion-help");