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 void 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. */
416 last_minibuf_string
= val
;
418 /* Add the value to the appropriate history list unless it is empty. */
419 if (XSTRING (val
)->size
!= 0
420 && SYMBOLP (Vminibuffer_history_variable
)
421 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
423 /* If the caller wanted to save the value read on a history list,
424 then do so if the value is not already the front of the list. */
426 histval
= Fsymbol_value (Vminibuffer_history_variable
);
428 /* The value of the history variable must be a cons or nil. Other
429 values are unacceptable. We silently ignore these values. */
432 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
436 histval
= Fcons (last_minibuf_string
, histval
);
437 Fset (Vminibuffer_history_variable
, histval
);
439 /* Truncate if requested. */
440 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
441 if (NILP (length
)) length
= Vhistory_length
;
442 if (INTEGERP (length
))
444 if (XINT (length
) <= 0)
445 Fset (Vminibuffer_history_variable
, Qnil
);
450 temp
= Fnthcdr (Fsub1 (length
), histval
);
451 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
457 /* If Lisp form desired instead of string, parse it. */
460 Lisp_Object expr_and_pos
;
463 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
464 /* Ignore trailing whitespace; any other trailing junk is an error. */
465 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
466 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
467 error ("Trailing garbage following expression");
468 val
= Fcar (expr_and_pos
);
471 /* The appropriate frame will get selected
472 in set-window-configuration. */
473 RETURN_UNGCPRO (unbind_to (count
, val
));
476 /* Return a buffer to be used as the minibuffer at depth `depth'.
477 depth = 0 is the lowest allowed argument, and that is the value
478 used for nonrecursive minibuffer invocations */
481 get_minibuffer (depth
)
484 Lisp_Object tail
, num
, buf
;
486 extern Lisp_Object
nconc2 ();
488 XSETFASTINT (num
, depth
);
489 tail
= Fnthcdr (num
, Vminibuffer_list
);
492 tail
= Fcons (Qnil
, Qnil
);
493 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
496 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
498 sprintf (name
, " *Minibuf-%d*", depth
);
499 buf
= Fget_buffer_create (build_string (name
));
501 /* Although the buffer's name starts with a space, undo should be
503 Fbuffer_enable_undo (buf
);
505 XCONS (tail
)->car
= buf
;
509 int count
= specpdl_ptr
- specpdl
;
511 reset_buffer (XBUFFER (buf
));
512 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
514 Fkill_all_local_variables ();
515 unbind_to (count
, Qnil
);
521 /* This function is called on exiting minibuffer, whether normally or not,
522 and it restores the current window, buffer, etc. */
525 read_minibuf_unwind (data
)
528 Lisp_Object old_deactivate_mark
;
531 /* We are exiting the minibuffer one way or the other,
533 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
534 && !NILP (Vrun_hooks
))
535 safe_run_hooks (Qminibuffer_exit_hook
);
537 /* If this was a recursive minibuffer,
538 tie the minibuffer window back to the outer level minibuffer buffer. */
541 window
= minibuf_window
;
542 /* To keep things predictable, in case it matters, let's be in the minibuffer
543 when we reset the relevant variables. */
544 Fset_buffer (XWINDOW (window
)->buffer
);
546 /* Restore prompt, etc, from outer minibuffer level. */
547 minibuf_prompt
= Fcar (minibuf_save_list
);
548 minibuf_save_list
= Fcdr (minibuf_save_list
);
549 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
550 minibuf_save_list
= Fcdr (minibuf_save_list
);
551 Vhelp_form
= Fcar (minibuf_save_list
);
552 minibuf_save_list
= Fcdr (minibuf_save_list
);
553 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
554 minibuf_save_list
= Fcdr (minibuf_save_list
);
555 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
556 minibuf_save_list
= Fcdr (minibuf_save_list
);
557 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
558 minibuf_save_list
= Fcdr (minibuf_save_list
);
559 Voverriding_local_map
= Fcar (minibuf_save_list
);
560 minibuf_save_list
= Fcdr (minibuf_save_list
);
562 temp
= Fcar (minibuf_save_list
);
563 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
564 minibuf_window
= temp
;
566 minibuf_save_list
= Fcdr (minibuf_save_list
);
568 /* Erase the minibuffer we were using at this level. */
570 int count
= specpdl_ptr
- specpdl
;
571 /* Prevent error in erase-buffer. */
572 specbind (Qinhibit_read_only
, Qt
);
573 old_deactivate_mark
= Vdeactivate_mark
;
575 Vdeactivate_mark
= old_deactivate_mark
;
576 unbind_to (count
, Qnil
);
579 /* Make sure minibuffer window is erased, not ignored. */
580 windows_or_buffers_changed
++;
581 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
582 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
586 /* This comment supplies the doc string for read-from-minibuffer,
587 for make-docfile to see. We cannot put this in the real DEFUN
588 due to limits in the Unix cpp.
590 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
591 "Read a string from the minibuffer, prompting with string PROMPT.\n\
592 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
593 to be inserted into the minibuffer before reading input.\n\
594 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
595 is STRING, but point is placed at position POSITION in the minibuffer.\n\
596 Third arg KEYMAP is a keymap to use whilst reading;\n\
597 if omitted or nil, the default is `minibuffer-local-map'.\n\
598 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
599 and return that object:\n\
600 in other words, do `(car (read-from-string INPUT-STRING))'\n\
601 Fifth arg HIST, if non-nil, specifies a history list\n\
602 and optionally the initial position in the list.\n\
603 It can be a symbol, which is the history list variable to use,\n\
604 or it can be a cons cell (HISTVAR . HISTPOS).\n\
605 In that case, HISTVAR is the history list variable to use,\n\
606 and HISTPOS is the initial position (the position in the list\n\
607 which INITIAL-CONTENTS corresponds to).\n\
608 Positions are counted starting from 1 at the beginning of the list.\n\
609 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
610 for history commands, and as the value to return if the user enters\n\
612 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
613 the current input method and the setting of enable-multibyte-characters.\n\
614 If the variable `minibuffer-allow-text-properties is non-nil,\n\
615 then the string which is returned includes whatever text properties\n\
616 were present in the minibuffer. Otherwise the value has no text properties.")
617 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
620 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 7, 0,
621 0 /* See immediately above */)
622 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
, inherit_input_method
)
623 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
624 Lisp_Object inherit_input_method
;
627 Lisp_Object histvar
, histpos
, position
, val
;
632 CHECK_STRING (prompt
, 0);
633 if (!NILP (initial_contents
))
635 if (CONSP (initial_contents
))
637 position
= Fcdr (initial_contents
);
638 initial_contents
= Fcar (initial_contents
);
640 CHECK_STRING (initial_contents
, 1);
641 if (!NILP (position
))
643 CHECK_NUMBER (position
, 0);
644 /* Convert to distance from end of input. */
645 if (XINT (position
) < 1)
646 /* A number too small means the beginning of the string. */
647 pos
= - XSTRING (initial_contents
)->size
;
649 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
654 keymap
= Vminibuffer_local_map
;
656 keymap
= get_keymap (keymap
);
665 histvar
= Fcar_safe (hist
);
666 histpos
= Fcdr_safe (hist
);
669 histvar
= Qminibuffer_history
;
671 XSETFASTINT (histpos
, 0);
673 GCPRO1 (default_value
);
674 val
= read_minibuf (keymap
, initial_contents
, prompt
,
675 make_number (pos
), !NILP (read
),
676 histvar
, histpos
, default_value
,
677 minibuffer_allow_text_properties
,
678 !NILP (inherit_input_method
));
679 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
685 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
686 "Return a Lisp object read using the minibuffer.\n\
687 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
688 is a string to insert in the minibuffer before reading.")
689 (prompt
, initial_contents
)
690 Lisp_Object prompt
, initial_contents
;
692 CHECK_STRING (prompt
, 0);
693 if (!NILP (initial_contents
))
694 CHECK_STRING (initial_contents
, 1);
695 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
696 prompt
, Qnil
, 1, Qminibuffer_history
,
697 make_number (0), Qnil
, 0, 0);
700 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
701 "Return value of Lisp expression read using the minibuffer.\n\
702 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
703 is a string to insert in the minibuffer before reading.")
704 (prompt
, initial_contents
)
705 Lisp_Object prompt
, initial_contents
;
707 return Feval (Fread_minibuffer (prompt
, initial_contents
));
710 /* Functions that use the minibuffer to read various things. */
712 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 5, 0,
713 "Read a string from the minibuffer, prompting with string PROMPT.\n\
714 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
715 The third arg HISTORY, if non-nil, specifies a history list\n\
716 and optionally the initial position in the list.\n\
717 See `read-from-minibuffer' for details of HISTORY argument.\n\
718 Fourth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
719 the current input method and the setting of enable-multibyte-characters.")
720 (prompt
, initial_input
, history
, default_value
, inherit_input_method
)
721 Lisp_Object prompt
, initial_input
, history
, default_value
;
722 Lisp_Object inherit_input_method
;
724 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
725 Qnil
, history
, default_value
,
726 inherit_input_method
);
729 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 3, 0,
730 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
731 Prompt with PROMPT, and provide INIT as an initial value of the input string.\n\
732 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
733 the current input method and the setting of enable-multibyte-characters.")
734 (prompt
, init
, inherit_input_method
)
735 Lisp_Object prompt
, init
, inherit_input_method
;
737 CHECK_STRING (prompt
, 0);
739 CHECK_STRING (init
, 1);
741 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
,
742 0, Qminibuffer_history
, make_number (0), Qnil
, 0,
743 !NILP (inherit_input_method
));
746 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
747 "Read the name of a command and return as a symbol.\n\
748 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
749 (prompt
, default_value
)
750 Lisp_Object prompt
, default_value
;
752 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
753 Qnil
, Qnil
, default_value
, Qnil
),
758 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
759 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
760 Prompts with PROMPT.")
764 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
, Qnil
),
769 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
770 "Read the name of a user variable and return it as a symbol.\n\
771 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
772 A user variable is one whose documentation starts with a `*' character.")
773 (prompt
, default_value
)
774 Lisp_Object prompt
, default_value
;
776 return Fintern (Fcompleting_read (prompt
, Vobarray
,
777 Quser_variable_p
, Qt
,
778 Qnil
, Qnil
, default_value
, Qnil
),
782 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
783 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
784 Prompts with PROMPT.\n\
785 Optional second arg DEF is value to return if user enters an empty line.\n\
786 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
787 (prompt
, def
, require_match
)
788 Lisp_Object prompt
, def
, require_match
;
794 def
= XBUFFER (def
)->name
;
797 args
[0] = build_string ("%s(default %s) ");
800 prompt
= Fformat (3, args
);
802 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
803 require_match
, Qnil
, Qnil
, def
, Qnil
);
806 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
807 "Return common substring of all completions of STRING in ALIST.\n\
808 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
809 All that match are compared together; the longest initial sequence\n\
810 common to all matches is returned as a string.\n\
811 If there is no match at all, nil is returned.\n\
812 For an exact match, t is returned.\n\
814 ALIST can be an obarray instead of an alist.\n\
815 Then the print names of all symbols in the obarray are the possible matches.\n\
817 ALIST can also be a function to do the completion itself.\n\
818 It receives three arguments: the values STRING, PREDICATE and nil.\n\
819 Whatever it returns becomes the value of `try-completion'.\n\
821 If optional third argument PREDICATE is non-nil,\n\
822 it is used to test each possible match.\n\
823 The match is a candidate only if PREDICATE returns non-nil.\n\
824 The argument given to PREDICATE is the alist element\n\
825 or the symbol from the obarray.")
826 (string
, alist
, predicate
)
827 Lisp_Object string
, alist
, predicate
;
829 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
831 int compare
, matchsize
;
832 int list
= CONSP (alist
) || NILP (alist
);
835 Lisp_Object bucket
, zero
, end
, tem
;
836 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
838 CHECK_STRING (string
, 0);
839 if (!list
&& !VECTORP (alist
))
840 return call3 (alist
, string
, predicate
, Qnil
);
844 /* If ALIST is not a list, set TAIL just for gc pro. */
849 obsize
= XVECTOR (alist
)->size
;
850 bucket
= XVECTOR (alist
)->contents
[index
];
855 /* Get the next element of the alist or obarray. */
856 /* Exit the loop if the elements are all used up. */
857 /* elt gets the alist element or symbol.
858 eltstring gets the name to check as a completion. */
865 eltstring
= Fcar (elt
);
870 if (XFASTINT (bucket
) != 0)
873 eltstring
= Fsymbol_name (elt
);
874 if (XSYMBOL (bucket
)->next
)
875 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
877 XSETFASTINT (bucket
, 0);
879 else if (++index
>= obsize
)
883 bucket
= XVECTOR (alist
)->contents
[index
];
888 /* Is this element a possible completion? */
890 if (STRINGP (eltstring
)
891 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
892 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
893 XSTRING (string
)->size
))
898 XSETFASTINT (zero
, 0);
900 /* Ignore this element if it fails to match all the regexps. */
901 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
902 regexps
= XCONS (regexps
)->cdr
)
904 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
911 /* Ignore this element if there is a predicate
912 and the predicate doesn't like it. */
914 if (!NILP (predicate
))
916 if (EQ (predicate
, Qcommandp
))
917 tem
= Fcommandp (elt
);
920 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
921 tem
= call1 (predicate
, elt
);
924 if (NILP (tem
)) continue;
927 /* Update computation of how much all possible completions match */
930 if (NILP (bestmatch
))
931 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
934 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
935 matchsize
= scmp (XSTRING (bestmatch
)->data
,
936 XSTRING (eltstring
)->data
,
940 if (completion_ignore_case
)
942 /* If this is an exact match except for case,
943 use it as the best match rather than one that is not an
944 exact match. This way, we get the case pattern
945 of the actual match. */
946 if ((matchsize
== XSTRING (eltstring
)->size
947 && matchsize
< XSTRING (bestmatch
)->size
)
949 /* If there is more than one exact match ignoring case,
950 and one of them is exact including case,
952 /* If there is no exact match ignoring case,
953 prefer a match that does not change the case
955 ((matchsize
== XSTRING (eltstring
)->size
)
957 (matchsize
== XSTRING (bestmatch
)->size
)
958 && !bcmp (XSTRING (eltstring
)->data
,
959 XSTRING (string
)->data
, XSTRING (string
)->size
)
960 && bcmp (XSTRING (bestmatch
)->data
,
961 XSTRING (string
)->data
, XSTRING (string
)->size
)))
962 bestmatch
= eltstring
;
964 bestmatchsize
= matchsize
;
969 if (NILP (bestmatch
))
970 return Qnil
; /* No completions found */
971 /* If we are ignoring case, and there is no exact match,
972 and no additional text was supplied,
973 don't change the case of what the user typed. */
974 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
975 && XSTRING (bestmatch
)->size
> bestmatchsize
)
978 /* Return t if the supplied string is an exact match (counting case);
979 it does not require any change to be made. */
980 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
981 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
985 XSETFASTINT (zero
, 0); /* Else extract the part in which */
986 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
987 return Fsubstring (bestmatch
, zero
, end
);
990 /* Compare exactly LEN chars of strings at S1 and S2,
991 ignoring case if appropriate.
992 Return -1 if strings match,
993 else number of chars that match at the beginning. */
997 register unsigned char *s1
, *s2
;
1000 register int l
= len
;
1001 register unsigned char *start
= s1
;
1003 if (completion_ignore_case
)
1005 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
1010 while (l
&& *s1
++ == *s2
++)
1017 int match
= len
- l
;
1019 /* Now *--S1 is the unmatching byte. If it is in the middle of
1020 multi-byte form, we must say that the multi-byte character
1021 there doesn't match. */
1022 while (match
&& *--s1
>= 0xA0) match
--;
1027 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
1028 "Search for partial matches to STRING in ALIST.\n\
1029 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1030 The value is a list of all the strings from ALIST that match.\n\
1032 ALIST can be an obarray instead of an alist.\n\
1033 Then the print names of all symbols in the obarray are the possible matches.\n\
1035 ALIST can also be a function to do the completion itself.\n\
1036 It receives three arguments: the values STRING, PREDICATE and t.\n\
1037 Whatever it returns becomes the value of `all-completion'.\n\
1039 If optional third argument PREDICATE is non-nil,\n\
1040 it is used to test each possible match.\n\
1041 The match is a candidate only if PREDICATE returns non-nil.\n\
1042 The argument given to PREDICATE is the alist element\n\
1043 or the symbol from the obarray.\n\
1045 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1046 strings in ALIST that start with a space\n\
1047 are ignored unless STRING itself starts with a space.")
1048 (string
, alist
, predicate
, hide_spaces
)
1049 Lisp_Object string
, alist
, predicate
, hide_spaces
;
1051 Lisp_Object tail
, elt
, eltstring
;
1052 Lisp_Object allmatches
;
1053 int list
= CONSP (alist
) || NILP (alist
);
1055 Lisp_Object bucket
, tem
;
1056 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
1058 CHECK_STRING (string
, 0);
1059 if (!list
&& !VECTORP (alist
))
1061 return call3 (alist
, string
, predicate
, Qt
);
1065 /* If ALIST is not a list, set TAIL just for gc pro. */
1070 obsize
= XVECTOR (alist
)->size
;
1071 bucket
= XVECTOR (alist
)->contents
[index
];
1076 /* Get the next element of the alist or obarray. */
1077 /* Exit the loop if the elements are all used up. */
1078 /* elt gets the alist element or symbol.
1079 eltstring gets the name to check as a completion. */
1086 eltstring
= Fcar (elt
);
1091 if (XFASTINT (bucket
) != 0)
1094 eltstring
= Fsymbol_name (elt
);
1095 if (XSYMBOL (bucket
)->next
)
1096 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1098 XSETFASTINT (bucket
, 0);
1100 else if (++index
>= obsize
)
1104 bucket
= XVECTOR (alist
)->contents
[index
];
1109 /* Is this element a possible completion? */
1111 if (STRINGP (eltstring
)
1112 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1113 /* If HIDE_SPACES, reject alternatives that start with space
1114 unless the input starts with space. */
1115 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
1116 || XSTRING (eltstring
)->data
[0] != ' '
1117 || NILP (hide_spaces
))
1118 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1119 XSTRING (string
)->size
))
1122 Lisp_Object regexps
;
1124 XSETFASTINT (zero
, 0);
1126 /* Ignore this element if it fails to match all the regexps. */
1127 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1128 regexps
= XCONS (regexps
)->cdr
)
1130 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1134 if (CONSP (regexps
))
1137 /* Ignore this element if there is a predicate
1138 and the predicate doesn't like it. */
1140 if (!NILP (predicate
))
1142 if (EQ (predicate
, Qcommandp
))
1143 tem
= Fcommandp (elt
);
1146 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1147 tem
= call1 (predicate
, elt
);
1150 if (NILP (tem
)) continue;
1152 /* Ok => put it on the list. */
1153 allmatches
= Fcons (eltstring
, allmatches
);
1157 return Fnreverse (allmatches
);
1160 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1161 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1162 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1164 /* This comment supplies the doc string for completing-read,
1165 for make-docfile to see. We cannot put this in the real DEFUN
1166 due to limits in the Unix cpp.
1168 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1169 "Read a string in the minibuffer, with completion.\n\
1170 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1171 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1172 PREDICATE limits completion to a subset of TABLE.\n\
1173 See `try-completion' and `all-completions' for more details
1174 on completion, TABLE, and PREDICATE.\n\
1176 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1177 the input is (or completes to) an element of TABLE or is null.\n\
1178 If it is also not t, Return does not exit if it does non-null completion.\n\
1179 If the input is null, `completing-read' returns an empty string,\n\
1180 regardless of the value of REQUIRE-MATCH.\n\
1182 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1183 If it is (STRING . POSITION), the initial input\n\
1184 is STRING, but point is placed POSITION characters into the string.\n\
1185 HIST, if non-nil, specifies a history list\n\
1186 and optionally the initial position in the list.\n\
1187 It can be a symbol, which is the history list variable to use,\n\
1188 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1189 In that case, HISTVAR is the history list variable to use,\n\
1190 and HISTPOS is the initial position (the position in the list\n\
1191 which INITIAL-CONTENTS corresponds to).\n\
1192 Positions are counted starting from 1 at the beginning of the list.\n\
1193 DEF, if non-nil, is the default value.\n\
1195 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1196 the current input method and the setting of enable-multibyte-characters.\n\
1198 Completion ignores case if the ambient value of\n\
1199 `completion-ignore-case' is non-nil."
1201 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 8, 0,
1202 0 /* See immediately above */)
1203 (prompt
, table
, predicate
, require_match
, init
, hist
, def
, inherit_input_method
)
1204 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
, def
;
1205 Lisp_Object inherit_input_method
;
1207 Lisp_Object val
, histvar
, histpos
, position
;
1209 int count
= specpdl_ptr
- specpdl
;
1210 struct gcpro gcpro1
;
1211 int disable_multibyte
= EQ (table
, Qread_file_name_internal
);
1215 specbind (Qminibuffer_completion_table
, table
);
1216 specbind (Qminibuffer_completion_predicate
, predicate
);
1217 specbind (Qminibuffer_completion_confirm
,
1218 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1219 last_exact_completion
= Qnil
;
1226 position
= Fcdr (init
);
1229 CHECK_STRING (init
, 0);
1230 if (!NILP (position
))
1232 CHECK_NUMBER (position
, 0);
1233 /* Convert to distance from end of input. */
1234 pos
= XINT (position
) - XSTRING (init
)->size
;
1245 histvar
= Fcar_safe (hist
);
1246 histpos
= Fcdr_safe (hist
);
1249 histvar
= Qminibuffer_history
;
1251 XSETFASTINT (histpos
, 0);
1253 val
= read_minibuf (NILP (require_match
)
1254 ? Vminibuffer_local_completion_map
1255 : Vminibuffer_local_must_match_map
,
1256 init
, prompt
, make_number (pos
), 0,
1257 histvar
, histpos
, def
, 0,
1258 !NILP (inherit_input_method
));
1259 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1261 RETURN_UNGCPRO (unbind_to (count
, val
));
1264 Lisp_Object
Fminibuffer_completion_help ();
1265 Lisp_Object
assoc_for_completion ();
1266 /* A subroutine of Fintern_soft. */
1267 extern Lisp_Object
oblookup ();
1270 /* Test whether TXT is an exact completion. */
1272 test_completion (txt
)
1277 if (CONSP (Vminibuffer_completion_table
)
1278 || NILP (Vminibuffer_completion_table
))
1279 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1280 else if (VECTORP (Vminibuffer_completion_table
))
1282 /* Bypass intern-soft as that loses for nil */
1283 tem
= oblookup (Vminibuffer_completion_table
,
1284 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1287 else if (!NILP (Vminibuffer_completion_predicate
))
1288 return call1 (Vminibuffer_completion_predicate
, tem
);
1293 return call3 (Vminibuffer_completion_table
, txt
,
1294 Vminibuffer_completion_predicate
, Qlambda
);
1298 * 0 no possible completion
1299 * 1 was already an exact and unique completion
1300 * 3 was already an exact completion
1301 * 4 completed to an exact completion
1302 * 5 some completion happened
1303 * 6 no completion happened
1308 Lisp_Object completion
, tem
;
1311 struct gcpro gcpro1
, gcpro2
;
1313 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1314 Vminibuffer_completion_predicate
);
1315 last
= last_exact_completion
;
1316 last_exact_completion
= Qnil
;
1318 GCPRO2 (completion
, last
);
1320 if (NILP (completion
))
1323 temp_echo_area_glyphs (" [No match]");
1328 if (EQ (completion
, Qt
)) /* exact and unique match */
1335 tem
= Fstring_equal (completion
, Fbuffer_string());
1336 if (completedp
= NILP (tem
))
1338 Ferase_buffer (); /* Some completion happened */
1339 Finsert (1, &completion
);
1342 /* It did find a match. Do we match some possibility exactly now? */
1343 tem
= test_completion (Fbuffer_string ());
1346 /* not an exact match */
1351 Fminibuffer_completion_help ();
1353 temp_echo_area_glyphs (" [Next char not unique]");
1356 else if (completedp
)
1361 /* If the last exact completion and this one were the same,
1362 it means we've already given a "Complete but not unique"
1363 message and the user's hit TAB again, so now we give him help. */
1364 last_exact_completion
= completion
;
1367 tem
= Fbuffer_string ();
1368 if (!NILP (Fequal (tem
, last
)))
1369 Fminibuffer_completion_help ();
1375 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1378 assoc_for_completion (key
, list
)
1379 register Lisp_Object key
;
1382 register Lisp_Object tail
;
1384 if (completion_ignore_case
)
1385 key
= Fupcase (key
);
1387 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1389 register Lisp_Object elt
, tem
, thiscar
;
1391 if (!CONSP (elt
)) continue;
1392 thiscar
= Fcar (elt
);
1393 if (!STRINGP (thiscar
))
1395 if (completion_ignore_case
)
1396 thiscar
= Fupcase (thiscar
);
1397 tem
= Fequal (thiscar
, key
);
1398 if (!NILP (tem
)) return elt
;
1404 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1405 "Complete the minibuffer contents as far as possible.\n\
1406 Return nil if there is no valid completion, else t.\n\
1407 If no characters can be completed, display a list of possible completions.\n\
1408 If you repeat this command after it displayed such a list,\n\
1409 scroll the window of possible completions.")
1413 Lisp_Object window
, tem
;
1415 /* If the previous command was not this, then mark the completion
1417 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1418 Vminibuf_scroll_window
= Qnil
;
1420 window
= Vminibuf_scroll_window
;
1421 /* If there's a fresh completion window with a live buffer,
1422 and this command is repeated, scroll that window. */
1423 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1424 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1426 struct buffer
*obuf
= current_buffer
;
1428 Fset_buffer (XWINDOW (window
)->buffer
);
1429 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1431 /* If end is in view, scroll up to the beginning. */
1432 Fset_window_start (window
, make_number (BEGV
), Qnil
);
1434 /* Else scroll down one screen. */
1435 Fscroll_other_window (Qnil
);
1437 set_buffer_internal (obuf
);
1441 i
= do_completion ();
1448 temp_echo_area_glyphs (" [Sole completion]");
1452 temp_echo_area_glyphs (" [Complete, but not unique]");
1459 /* Subroutines of Fminibuffer_complete_and_exit. */
1461 /* This one is called by internal_condition_case to do the real work. */
1464 complete_and_exit_1 ()
1466 return make_number (do_completion ());
1469 /* This one is called by internal_condition_case if an error happens.
1470 Pretend the current value is an exact match. */
1473 complete_and_exit_2 (ignore
)
1476 return make_number (1);
1479 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1480 Sminibuffer_complete_and_exit
, 0, 0, "",
1481 "If the minibuffer contents is a valid completion then exit.\n\
1482 Otherwise try to complete it. If completion leads to a valid completion,\n\
1483 a repetition of this command will exit.")
1489 /* Allow user to specify null string */
1493 if (!NILP (test_completion (Fbuffer_string ())))
1496 /* Call do_completion, but ignore errors. */
1497 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1498 complete_and_exit_2
);
1508 if (!NILP (Vminibuffer_completion_confirm
))
1510 temp_echo_area_glyphs (" [Confirm]");
1520 Fthrow (Qexit
, Qnil
);
1524 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1526 "Complete the minibuffer contents at most a single word.\n\
1527 After one word is completed as much as possible, a space or hyphen\n\
1528 is added, provided that matches some possible completion.\n\
1529 Return nil if there is no valid completion, else t.")
1532 Lisp_Object completion
, tem
;
1534 register unsigned char *completion_string
;
1535 struct gcpro gcpro1
, gcpro2
;
1537 /* We keep calling Fbuffer_string rather than arrange for GC to
1538 hold onto a pointer to one of the strings thus made. */
1540 completion
= Ftry_completion (Fbuffer_string (),
1541 Vminibuffer_completion_table
,
1542 Vminibuffer_completion_predicate
);
1543 if (NILP (completion
))
1546 temp_echo_area_glyphs (" [No match]");
1549 if (EQ (completion
, Qt
))
1552 #if 0 /* How the below code used to look, for reference. */
1553 tem
= Fbuffer_string ();
1554 b
= XSTRING (tem
)->data
;
1555 i
= ZV
- 1 - XSTRING (completion
)->size
;
1556 p
= XSTRING (completion
)->data
;
1558 0 <= scmp (b
, p
, ZV
- 1))
1561 /* Set buffer to longest match of buffer tail and completion head. */
1562 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1564 del_range (1, i
+ 1);
1567 #else /* Rewritten code */
1569 register unsigned char *buffer_string
;
1570 int buffer_length
, completion_length
;
1572 CHECK_STRING (completion
, 0);
1573 tem
= Fbuffer_string ();
1574 GCPRO2 (completion
, tem
);
1575 /* If reading a file name,
1576 expand any $ENVVAR refs in the buffer and in TEM. */
1577 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1579 Lisp_Object substituted
;
1580 substituted
= Fsubstitute_in_file_name (tem
);
1581 if (! EQ (substituted
, tem
))
1585 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1588 buffer_string
= XSTRING (tem
)->data
;
1589 completion_string
= XSTRING (completion
)->data
;
1590 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1591 completion_length
= XSTRING (completion
)->size
;
1592 i
= buffer_length
- completion_length
;
1593 /* Mly: I don't understand what this is supposed to do AT ALL */
1595 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1597 /* Set buffer to longest match of buffer tail and completion head. */
1601 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1603 del_range (1, i
+ 1);
1608 #endif /* Rewritten code */
1611 /* If completion finds next char not unique,
1612 consider adding a space or a hyphen. */
1613 if (i
== XSTRING (completion
)->size
)
1615 GCPRO1 (completion
);
1616 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1617 Vminibuffer_completion_table
,
1618 Vminibuffer_completion_predicate
);
1625 GCPRO1 (completion
);
1627 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1628 Vminibuffer_completion_table
,
1629 Vminibuffer_completion_predicate
);
1637 /* Now find first word-break in the stuff found by completion.
1638 i gets index in string of where to stop completing. */
1642 completion_string
= XSTRING (completion
)->data
;
1643 for (; i
< XSTRING (completion
)->size
; i
+= len
)
1645 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i
,
1646 XSTRING (completion
)->size
- i
,
1648 if (SYNTAX (c
) != Sword
)
1656 /* If got no characters, print help for user. */
1661 Fminibuffer_completion_help ();
1665 /* Otherwise insert in minibuffer the chars we got */
1668 insert_from_string (completion
, 0, i
, 1);
1672 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1674 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1675 Each element may be just a symbol or string\n\
1676 or may be a list of two strings to be printed as if concatenated.\n\
1677 `standard-output' must be a buffer.\n\
1678 At the end, run the normal hook `completion-setup-hook'.\n\
1679 It can find the completion buffer in `standard-output'.")
1681 Lisp_Object completions
;
1683 Lisp_Object tail
, elt
;
1686 struct gcpro gcpro1
, gcpro2
;
1687 struct buffer
*old
= current_buffer
;
1690 /* Note that (when it matters) every variable
1691 points to a non-string that is pointed to by COMPLETIONS,
1692 except for ELT. ELT can be pointing to a string
1693 when terpri or Findent_to calls a change hook. */
1695 GCPRO2 (completions
, elt
);
1697 if (BUFFERP (Vstandard_output
))
1698 set_buffer_internal (XBUFFER (Vstandard_output
));
1700 if (NILP (completions
))
1701 write_string ("There are no possible completions of what you have typed.",
1705 write_string ("Possible completions are:", -1);
1706 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1710 Lisp_Object startpos
, endpos
;
1713 /* Compute the length of this element. */
1717 CHECK_STRING (tem
, 0);
1718 length
= XSTRING (tem
)->size
;
1720 tem
= Fcar (XCDR (elt
));
1721 CHECK_STRING (tem
, 0);
1722 length
+= XSTRING (tem
)->size
;
1726 CHECK_STRING (elt
, 0);
1727 length
= XSTRING (elt
)->size
;
1730 /* This does a bad job for narrower than usual windows.
1731 Sadly, the window it will appear in is not known
1732 until after the text has been made. */
1734 if (BUFFERP (Vstandard_output
))
1735 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1737 /* If the previous completion was very wide,
1738 or we have two on this line already,
1739 don't put another on the same line. */
1740 if (column
> 33 || first
1741 /* If this is really wide, don't put it second on a line. */
1742 || column
> 0 && length
> 45)
1747 /* Otherwise advance to column 35. */
1750 if (BUFFERP (Vstandard_output
))
1752 tem
= Findent_to (make_number (35), make_number (2));
1754 column
= XINT (tem
);
1760 write_string (" ", -1);
1763 while (column
< 35);
1767 if (BUFFERP (Vstandard_output
))
1769 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1770 Fset_text_properties (startpos
, endpos
,
1771 Qnil
, Vstandard_output
);
1774 /* Output this element and update COLUMN. */
1777 Fprinc (Fcar (elt
), Qnil
);
1778 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1785 /* If output is to a buffer, recompute COLUMN in a way
1786 that takes account of character widths. */
1787 if (BUFFERP (Vstandard_output
))
1789 tem
= Fcurrent_column ();
1790 column
= XINT (tem
);
1799 if (BUFFERP (Vstandard_output
))
1800 set_buffer_internal (old
);
1802 if (!NILP (Vrun_hooks
))
1803 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1808 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1810 "Display a list of possible completions of the current minibuffer contents.")
1813 Lisp_Object completions
;
1815 message ("Making completion list...");
1816 completions
= Fall_completions (Fbuffer_string (),
1817 Vminibuffer_completion_table
,
1818 Vminibuffer_completion_predicate
,
1820 echo_area_glyphs
= 0;
1822 if (NILP (completions
))
1825 temp_echo_area_glyphs (" [No completions]");
1828 internal_with_output_to_temp_buffer ("*Completions*",
1829 Fdisplay_completion_list
,
1830 Fsort (completions
, Qstring_lessp
));
1834 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1835 "Terminate minibuffer input.")
1838 if (INTEGERP (last_command_char
))
1839 internal_self_insert (last_command_char
, 0);
1843 Fthrow (Qexit
, Qnil
);
1846 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1847 "Terminate this minibuffer argument.")
1850 Fthrow (Qexit
, Qnil
);
1853 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1854 "Return current depth of activations of minibuffer, a nonnegative integer.")
1857 return make_number (minibuf_level
);
1860 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1861 "Return the prompt string of the currently-active minibuffer.\n\
1862 If no minibuffer is active, return nil.")
1865 return Fcopy_sequence (minibuf_prompt
);
1868 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1869 Sminibuffer_prompt_width
, 0, 0, 0,
1870 "Return the display width of the minibuffer prompt.")
1874 XSETFASTINT (width
, minibuf_prompt_width
);
1878 /* Temporarily display the string M at the end of the current
1879 minibuffer contents. This is used to display things like
1880 "[No Match]" when the user requests a completion for a prefix
1881 that has no possible completions, and other quick, unobtrusive
1884 temp_echo_area_glyphs (m
)
1889 Lisp_Object oinhibit
;
1890 oinhibit
= Vinhibit_quit
;
1892 /* Clear out any old echo-area message to make way for our new thing. */
1899 Fsit_for (make_number (2), Qnil
, Qnil
);
1900 del_range (osize
, ZV
);
1902 if (!NILP (Vquit_flag
))
1905 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1907 Vinhibit_quit
= oinhibit
;
1910 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
1912 "Temporarily display STRING at the end of the minibuffer.\n\
1913 The text is displayed for two seconds,\n\
1914 or until the next input event arrives, whichever comes first.")
1918 temp_echo_area_glyphs (XSTRING (string
)->data
);
1922 init_minibuf_once ()
1924 Vminibuffer_list
= Qnil
;
1925 staticpro (&Vminibuffer_list
);
1931 minibuf_prompt
= Qnil
;
1932 staticpro (&minibuf_prompt
);
1934 minibuf_save_list
= Qnil
;
1935 staticpro (&minibuf_save_list
);
1937 Qread_file_name_internal
= intern ("read-file-name-internal");
1938 staticpro (&Qread_file_name_internal
);
1940 Qminibuffer_default
= intern ("minibuffer-default");
1941 staticpro (&Qminibuffer_default
);
1942 Fset (Qminibuffer_default
, Qnil
);
1944 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1945 staticpro (&Qminibuffer_completion_table
);
1947 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1948 staticpro (&Qminibuffer_completion_confirm
);
1950 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1951 staticpro (&Qminibuffer_completion_predicate
);
1953 staticpro (&last_exact_completion
);
1954 last_exact_completion
= Qnil
;
1956 staticpro (&last_minibuf_string
);
1957 last_minibuf_string
= Qnil
;
1959 Quser_variable_p
= intern ("user-variable-p");
1960 staticpro (&Quser_variable_p
);
1962 Qminibuffer_history
= intern ("minibuffer-history");
1963 staticpro (&Qminibuffer_history
);
1965 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1966 staticpro (&Qminibuffer_setup_hook
);
1968 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1969 staticpro (&Qminibuffer_exit_hook
);
1971 Qhistory_length
= intern ("history-length");
1972 staticpro (&Qhistory_length
);
1974 Qcurrent_input_method
= intern ("current-input-method");
1975 staticpro (&Qcurrent_input_method
);
1977 Qactivate_input_method
= intern ("activate-input-method");
1978 staticpro (&Qactivate_input_method
);
1980 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1981 "Normal hook run just after entry to minibuffer.");
1982 Vminibuffer_setup_hook
= Qnil
;
1984 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1985 "Normal hook run just after exit from minibuffer.");
1986 Vminibuffer_exit_hook
= Qnil
;
1988 DEFVAR_LISP ("history-length", &Vhistory_length
,
1989 "*Maximum length for history lists before truncation takes place.\n\
1990 A number means that length; t means infinite. Truncation takes place\n\
1991 just after a new element is inserted. Setting the history-length\n\
1992 property of a history variable overrides this default.");
1993 XSETFASTINT (Vhistory_length
, 30);
1995 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1996 "*Non-nil means automatically provide help for invalid completion input.");
1999 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
2000 "Non-nil means don't consider case significant in completion.");
2001 completion_ignore_case
= 0;
2003 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
2004 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2005 This variable makes a difference whenever the minibuffer window is active.");
2006 enable_recursive_minibuffers
= 0;
2008 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
2009 "Alist or obarray used for completion in the minibuffer.\n\
2010 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2012 The value may alternatively be a function, which is given three arguments:\n\
2013 STRING, the current buffer contents;\n\
2014 PREDICATE, the predicate for filtering possible matches;\n\
2015 CODE, which says what kind of things to do.\n\
2016 CODE can be nil, t or `lambda'.\n\
2017 nil means to return the best completion of STRING, or nil if there is none.\n\
2018 t means to return a list of all possible completions of STRING.\n\
2019 `lambda' means to return t if STRING is a valid completion as it stands.");
2020 Vminibuffer_completion_table
= Qnil
;
2022 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
2023 "Within call to `completing-read', this holds the PREDICATE argument.");
2024 Vminibuffer_completion_predicate
= Qnil
;
2026 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
2027 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2028 Vminibuffer_completion_confirm
= Qnil
;
2030 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
2031 "Value that `help-form' takes on inside the minibuffer.");
2032 Vminibuffer_help_form
= Qnil
;
2034 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
2035 "History list symbol to add minibuffer values to.\n\
2036 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2038 (set minibuffer-history-variable\n\
2039 (cons STRING (symbol-value minibuffer-history-variable)))");
2040 XSETFASTINT (Vminibuffer_history_variable
, 0);
2042 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
2043 "Current position of redoing in the history list.");
2044 Vminibuffer_history_position
= Qnil
;
2046 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
2047 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2048 Some uses of the echo area also raise that frame (since they use it too).");
2049 minibuffer_auto_raise
= 0;
2051 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
2052 "List of regexps that should restrict possible completions.");
2053 Vcompletion_regexp_list
= Qnil
;
2055 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2056 &minibuffer_allow_text_properties
,
2057 "Non-nil means `read-from-miniffer' should not discard text properties.\n\
2058 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2059 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2060 with completion; they always discard text properties.");
2061 minibuffer_allow_text_properties
= 0;
2063 defsubr (&Sset_minibuffer_window
);
2064 defsubr (&Sread_from_minibuffer
);
2065 defsubr (&Seval_minibuffer
);
2066 defsubr (&Sread_minibuffer
);
2067 defsubr (&Sread_string
);
2068 defsubr (&Sread_command
);
2069 defsubr (&Sread_variable
);
2070 defsubr (&Sread_buffer
);
2071 defsubr (&Sread_no_blanks_input
);
2072 defsubr (&Sminibuffer_depth
);
2073 defsubr (&Sminibuffer_prompt
);
2074 defsubr (&Sminibuffer_prompt_width
);
2076 defsubr (&Stry_completion
);
2077 defsubr (&Sall_completions
);
2078 defsubr (&Scompleting_read
);
2079 defsubr (&Sminibuffer_complete
);
2080 defsubr (&Sminibuffer_complete_word
);
2081 defsubr (&Sminibuffer_complete_and_exit
);
2082 defsubr (&Sdisplay_completion_list
);
2083 defsubr (&Sminibuffer_completion_help
);
2085 defsubr (&Sself_insert_and_exit
);
2086 defsubr (&Sexit_minibuffer
);
2088 defsubr (&Sminibuffer_message
);
2093 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2094 "abort-recursive-edit");
2095 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2097 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2100 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2101 "abort-recursive-edit");
2102 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2104 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2107 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2109 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2111 initial_define_key (Vminibuffer_local_ns_map
, '?',
2112 "self-insert-and-exit");
2114 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2115 "abort-recursive-edit");
2116 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2118 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2121 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2122 "minibuffer-complete");
2123 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2124 "minibuffer-complete-word");
2125 initial_define_key (Vminibuffer_local_completion_map
, '?',
2126 "minibuffer-completion-help");
2128 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2129 "abort-recursive-edit");
2130 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2131 "minibuffer-complete-and-exit");
2132 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2133 "minibuffer-complete-and-exit");
2134 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2135 "minibuffer-complete");
2136 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2137 "minibuffer-complete-word");
2138 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2139 "minibuffer-completion-help");