1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 93, 94, 95, 1996 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
27 #include "dispextern.h"
33 #define min(a, b) ((a) < (b) ? (a) : (b))
37 /* List of buffers for use as minibuffers.
38 The first element of the list is used for the outermost minibuffer
39 invocation, the next element is used for a recursive minibuffer
40 invocation, etc. The list is extended at the end as deeper
41 minibuffer recursions are encountered. */
42 Lisp_Object Vminibuffer_list
;
44 /* Data to remember during recursive minibuffer invocations */
45 Lisp_Object minibuf_save_list
;
47 /* Depth in minibuffer invocations. */
50 /* Nonzero means display completion help for invalid input. */
53 /* The maximum length of a minibuffer history. */
54 Lisp_Object Qhistory_length
, Vhistory_length
;
56 /* Fread_minibuffer leaves the input here as a string. */
57 Lisp_Object last_minibuf_string
;
59 /* Nonzero means let functions called when within a minibuffer
60 invoke recursive minibuffers (to read arguments, or whatever) */
61 int enable_recursive_minibuffers
;
63 /* help-form is bound to this while in the minibuffer. */
65 Lisp_Object Vminibuffer_help_form
;
67 /* Variable which is the history list to add minibuffer values to. */
69 Lisp_Object Vminibuffer_history_variable
;
71 /* Current position in the history list (adjusted by M-n and M-p). */
73 Lisp_Object Vminibuffer_history_position
;
75 Lisp_Object Qminibuffer_history
;
77 Lisp_Object Qread_file_name_internal
;
79 /* Normal hooks for entry to and exit from minibuffer. */
81 Lisp_Object Qminibuffer_setup_hook
, Vminibuffer_setup_hook
;
82 Lisp_Object Qminibuffer_exit_hook
, Vminibuffer_exit_hook
;
84 /* Nonzero means completion ignores case. */
86 int completion_ignore_case
;
88 /* List of regexps that should restrict possible completions. */
90 Lisp_Object Vcompletion_regexp_list
;
92 /* Nonzero means raise the minibuffer frame when the minibuffer
95 int minibuffer_auto_raise
;
97 /* If last completion attempt reported "Complete but not unique"
98 then this is the string completed then; otherwise this is nil. */
100 static Lisp_Object last_exact_completion
;
102 Lisp_Object Quser_variable_p
;
104 Lisp_Object Qminibuffer_default
;
106 /* Non-nil means it is the window for C-M-v to scroll
107 when the minibuffer is selected. */
108 extern Lisp_Object Vminibuf_scroll_window
;
110 extern Lisp_Object Voverriding_local_map
;
112 /* Put minibuf on currently selected frame's minibuffer.
113 We do this whenever the user starts a new minibuffer
114 or when a minibuffer exits. */
117 choose_minibuf_frame ()
119 if (selected_frame
!= 0
120 && !EQ (minibuf_window
, selected_frame
->minibuffer_window
))
122 /* I don't think that any frames may validly have a null minibuffer
124 if (NILP (selected_frame
->minibuffer_window
))
127 Fset_window_buffer (selected_frame
->minibuffer_window
,
128 XWINDOW (minibuf_window
)->buffer
);
129 minibuf_window
= selected_frame
->minibuffer_window
;
132 /* Make sure no other frame has a minibuffer as its selected window,
133 because the text would not be displayed in it, and that would be
134 confusing. Only allow the selected frame to do this,
135 and that only if the minibuffer is active. */
137 Lisp_Object tail
, frame
;
139 FOR_EACH_FRAME (tail
, frame
)
140 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame
))))
141 && !(XFRAME (frame
) == selected_frame
142 && minibuf_level
> 0))
143 Fset_frame_selected_window (frame
, Fframe_first_window (frame
));
147 DEFUN ("set-minibuffer-window", Fset_minibuffer_window
,
148 Sset_minibuffer_window
, 1, 1, 0,
149 "Specify which minibuffer window to use for the minibuffer.\n\
150 This effects where the minibuffer is displayed if you put text in it\n\
151 without invoking the usual minibuffer commands.")
155 CHECK_WINDOW (window
, 1);
156 if (! MINI_WINDOW_P (XWINDOW (window
)))
157 error ("Window is not a minibuffer window");
159 minibuf_window
= window
;
165 /* Actual minibuffer invocation. */
167 static void read_minibuf_unwind ();
168 Lisp_Object
get_minibuffer ();
169 static Lisp_Object
read_minibuf ();
171 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
172 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
173 prompting with PROMPT (a string), using history list HISTVAR
174 with initial position HISTPOS. (BACKUP_N should be <= 0.)
176 Normally return the result as a string (the text that was read),
177 but if EXPFLAG is nonzero, read it and return the object read.
178 If HISTVAR is given, save the value read on that history only if it doesn't
179 match the front of that history list exactly. The value is pushed onto
180 the list as the string that was read.
182 DEFALT specifies te default value for the sake of history commands. */
185 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
,
186 histvar
, histpos
, defalt
)
190 Lisp_Object backup_n
;
197 int count
= specpdl_ptr
- specpdl
;
198 Lisp_Object mini_frame
, ambient_dir
, minibuffer
;
199 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
201 specbind (Qminibuffer_default
, defalt
);
203 single_kboard_state ();
206 ambient_dir
= current_buffer
->directory
;
208 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
209 store them away before we can GC. Don't need to protect
210 BACKUP_N because we use the value only if it is an integer. */
211 GCPRO4 (map
, initial
, val
, ambient_dir
);
213 if (!STRINGP (prompt
))
214 prompt
= build_string ("");
216 if (!enable_recursive_minibuffers
217 && minibuf_level
> 0)
219 if (EQ (selected_window
, minibuf_window
))
220 error ("Command attempted to use minibuffer while in minibuffer");
222 /* If we're in another window, cancel the minibuffer that's active. */
224 build_string ("Command attempted to use minibuffer while in minibuffer"));
227 /* Choose the minibuffer window and frame, and take action on them. */
229 choose_minibuf_frame ();
231 record_unwind_protect (Fset_window_configuration
,
232 Fcurrent_window_configuration (Qnil
));
234 /* If the minibuffer window is on a different frame, save that
235 frame's configuration too. */
236 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
237 if (XFRAME (mini_frame
) != selected_frame
)
238 record_unwind_protect (Fset_window_configuration
,
239 Fcurrent_window_configuration (mini_frame
));
241 /* If the minibuffer is on an iconified or invisible frame,
242 make it visible now. */
243 Fmake_frame_visible (mini_frame
);
245 if (minibuffer_auto_raise
)
246 Fraise_frame (mini_frame
);
248 /* We have to do this after saving the window configuration
249 since that is what restores the current buffer. */
251 /* Arrange to restore a number of minibuffer-related variables.
252 We could bind each variable separately, but that would use lots of
255 = Fcons (Voverriding_local_map
,
256 Fcons (minibuf_window
, minibuf_save_list
));
258 = Fcons (minibuf_prompt
,
259 Fcons (make_number (minibuf_prompt_width
),
261 Fcons (Vcurrent_prefix_arg
,
262 Fcons (Vminibuffer_history_position
,
263 Fcons (Vminibuffer_history_variable
,
264 minibuf_save_list
))))));
266 record_unwind_protect (read_minibuf_unwind
, Qnil
);
269 /* Now that we can restore all those variables, start changing them. */
271 minibuf_prompt_width
= 0; /* xdisp.c puts in the right value. */
272 minibuf_prompt
= Fcopy_sequence (prompt
);
273 Vminibuffer_history_position
= histpos
;
274 Vminibuffer_history_variable
= histvar
;
275 Vhelp_form
= Vminibuffer_help_form
;
277 /* Switch to the minibuffer. */
279 minibuffer
= get_minibuffer (minibuf_level
);
280 Fset_buffer (minibuffer
);
282 /* The current buffer's default directory is usually the right thing
283 for our minibuffer here. However, if you're typing a command at
284 a minibuffer-only frame when minibuf_level is zero, then buf IS
285 the current_buffer, so reset_buffer leaves buf's default
286 directory unchanged. This is a bummer when you've just started
287 up Emacs and buf's default directory is Qnil. Here's a hack; can
288 you think of something better to do? Find another buffer with a
289 better directory, and use that one instead. */
290 if (STRINGP (ambient_dir
))
291 current_buffer
->directory
= ambient_dir
;
294 Lisp_Object buf_list
;
296 for (buf_list
= Vbuffer_alist
;
298 buf_list
= XCONS (buf_list
)->cdr
)
300 Lisp_Object other_buf
;
302 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
303 if (STRINGP (XBUFFER (other_buf
)->directory
))
305 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
311 if (XFRAME (mini_frame
) != selected_frame
)
312 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
314 Vminibuf_scroll_window
= selected_window
;
315 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
316 Fselect_window (minibuf_window
);
317 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
319 Fmake_local_variable (Qprint_escape_newlines
);
320 print_escape_newlines
= 1;
322 /* Erase the buffer. */
324 int count1
= specpdl_ptr
- specpdl
;
325 specbind (Qinhibit_read_only
, Qt
);
327 unbind_to (count1
, Qnil
);
330 /* Put in the initial input. */
333 Finsert (1, &initial
);
334 if (!NILP (backup_n
) && INTEGERP (backup_n
))
335 Fgoto_char (make_number (PT
+ XFASTINT (backup_n
)));
338 echo_area_glyphs
= 0;
339 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
340 previous_echo_glyphs
= 0;
342 current_buffer
->keymap
= map
;
344 /* Run our hook, but not if it is empty.
345 (run-hooks would do nothing if it is empty,
346 but it's important to save time here in the usual case). */
347 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
348 && !NILP (Vrun_hooks
))
349 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
351 /* ??? MCC did redraw_screen here if switching screens. */
354 /* If cursor is on the minibuffer line,
355 show the user we have exited by putting it in column 0. */
356 if ((FRAME_CURSOR_Y (selected_frame
)
357 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
360 FRAME_CURSOR_X (selected_frame
)
361 = FRAME_LEFT_SCROLL_BAR_WIDTH (selected_frame
);
362 update_frame (selected_frame
, 1, 1);
365 /* Make minibuffer contents into a string */
366 Fset_buffer (minibuffer
);
367 val
= make_buffer_string (1, Z
, 1);
368 #if 0 /* make_buffer_string should handle the gap. */
369 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
372 /* VAL is the string of minibuffer text. */
373 last_minibuf_string
= val
;
375 /* Add the value to the appropriate history list unless it is empty. */
376 if (XSTRING (val
)->size
!= 0
377 && SYMBOLP (Vminibuffer_history_variable
)
378 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
380 /* If the caller wanted to save the value read on a history list,
381 then do so if the value is not already the front of the list. */
383 histval
= Fsymbol_value (Vminibuffer_history_variable
);
385 /* The value of the history variable must be a cons or nil. Other
386 values are unacceptable. We silently ignore these values. */
389 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
393 histval
= Fcons (last_minibuf_string
, histval
);
394 Fset (Vminibuffer_history_variable
, histval
);
396 /* Truncate if requested. */
397 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
398 if (NILP (length
)) length
= Vhistory_length
;
399 if (INTEGERP (length
))
401 if (XINT (length
) <= 0)
402 Fset (Vminibuffer_history_variable
, Qnil
);
407 temp
= Fnthcdr (Fsub1 (length
), histval
);
408 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
414 /* If Lisp form desired instead of string, parse it. */
417 Lisp_Object expr_and_pos
;
420 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
421 /* Ignore trailing whitespace; any other trailing junk is an error. */
422 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
423 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
424 error ("Trailing garbage following expression");
425 val
= Fcar (expr_and_pos
);
428 /* The appropriate frame will get selected
429 in set-window-configuration. */
430 RETURN_UNGCPRO (unbind_to (count
, val
));
433 /* Return a buffer to be used as the minibuffer at depth `depth'.
434 depth = 0 is the lowest allowed argument, and that is the value
435 used for nonrecursive minibuffer invocations */
438 get_minibuffer (depth
)
441 Lisp_Object tail
, num
, buf
;
443 extern Lisp_Object
nconc2 ();
445 XSETFASTINT (num
, depth
);
446 tail
= Fnthcdr (num
, Vminibuffer_list
);
449 tail
= Fcons (Qnil
, Qnil
);
450 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
453 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
455 sprintf (name
, " *Minibuf-%d*", depth
);
456 buf
= Fget_buffer_create (build_string (name
));
458 /* Although the buffer's name starts with a space, undo should be
460 Fbuffer_enable_undo (buf
);
462 XCONS (tail
)->car
= buf
;
466 int count
= specpdl_ptr
- specpdl
;
468 reset_buffer (XBUFFER (buf
));
469 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
471 Fkill_all_local_variables ();
472 unbind_to (count
, Qnil
);
478 /* This function is called on exiting minibuffer, whether normally or not,
479 and it restores the current window, buffer, etc. */
482 read_minibuf_unwind (data
)
485 Lisp_Object old_deactivate_mark
;
488 /* We are exiting the minibuffer one way or the other,
490 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
491 && !NILP (Vrun_hooks
))
492 safe_run_hooks (Qminibuffer_exit_hook
);
494 /* If this was a recursive minibuffer,
495 tie the minibuffer window back to the outer level minibuffer buffer. */
498 window
= minibuf_window
;
499 /* To keep things predictable, in case it matters, let's be in the minibuffer
500 when we reset the relevant variables. */
501 Fset_buffer (XWINDOW (window
)->buffer
);
503 /* Restore prompt, etc, from outer minibuffer level. */
504 minibuf_prompt
= Fcar (minibuf_save_list
);
505 minibuf_save_list
= Fcdr (minibuf_save_list
);
506 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
507 minibuf_save_list
= Fcdr (minibuf_save_list
);
508 Vhelp_form
= Fcar (minibuf_save_list
);
509 minibuf_save_list
= Fcdr (minibuf_save_list
);
510 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
511 minibuf_save_list
= Fcdr (minibuf_save_list
);
512 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
513 minibuf_save_list
= Fcdr (minibuf_save_list
);
514 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
515 minibuf_save_list
= Fcdr (minibuf_save_list
);
516 Voverriding_local_map
= Fcar (minibuf_save_list
);
517 minibuf_save_list
= Fcdr (minibuf_save_list
);
519 temp
= Fcar (minibuf_save_list
);
520 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp
)))))
521 minibuf_window
= temp
;
523 minibuf_save_list
= Fcdr (minibuf_save_list
);
525 /* Erase the minibuffer we were using at this level. */
527 int count
= specpdl_ptr
- specpdl
;
528 /* Prevent error in erase-buffer. */
529 specbind (Qinhibit_read_only
, Qt
);
530 old_deactivate_mark
= Vdeactivate_mark
;
532 Vdeactivate_mark
= old_deactivate_mark
;
533 unbind_to (count
, Qnil
);
536 /* Make the minibuffer follow the selected frame
537 (in case we are exiting a recursive minibuffer). */
538 choose_minibuf_frame ();
540 /* Make sure minibuffer window is erased, not ignored. */
541 windows_or_buffers_changed
++;
542 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
543 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
547 /* This comment supplies the doc string for read-from-minibuffer,
548 for make-docfile to see. We cannot put this in the real DEFUN
549 due to limits in the Unix cpp.
551 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
552 "Read a string from the minibuffer, prompting with string PROMPT.\n\
553 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
554 to be inserted into the minibuffer before reading input.\n\
555 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
556 is STRING, but point is placed at position POSITION in the minibuffer.\n\
557 Third arg KEYMAP is a keymap to use whilst reading;\n\
558 if omitted or nil, the default is `minibuffer-local-map'.\n\
559 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
560 and return that object:\n\
561 in other words, do `(car (read-from-string INPUT-STRING))'\n\
562 Fifth arg HIST, if non-nil, specifies a history list\n\
563 and optionally the initial position in the list.\n\
564 It can be a symbol, which is the history list variable to use,\n\
565 or it can be a cons cell (HISTVAR . HISTPOS).\n\
566 In that case, HISTVAR is the history list variable to use,\n\
567 and HISTPOS is the initial position (the position in the list\n\
568 which INITIAL-CONTENTS corresponds to).\n\
569 Positions are counted starting from 1 at the beginning of the list.\n\
570 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
571 for history commands, and as the value to return if the user enters\n\
575 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 6, 0,
576 0 /* See immediately above */)
577 (prompt
, initial_contents
, keymap
, read
, hist
, default_value
)
578 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
, default_value
;
581 Lisp_Object histvar
, histpos
, position
, val
;
584 CHECK_STRING (prompt
, 0);
585 if (!NILP (initial_contents
))
587 if (CONSP (initial_contents
))
589 position
= Fcdr (initial_contents
);
590 initial_contents
= Fcar (initial_contents
);
592 CHECK_STRING (initial_contents
, 1);
593 if (!NILP (position
))
595 CHECK_NUMBER (position
, 0);
596 /* Convert to distance from end of input. */
597 if (XINT (position
) < 1)
598 /* A number too small means the beginning of the string. */
599 pos
= - XSTRING (initial_contents
)->size
;
601 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
606 keymap
= Vminibuffer_local_map
;
608 keymap
= get_keymap (keymap
,2);
617 histvar
= Fcar_safe (hist
);
618 histpos
= Fcdr_safe (hist
);
621 histvar
= Qminibuffer_history
;
623 XSETFASTINT (histpos
, 0);
625 val
= read_minibuf (keymap
, initial_contents
, prompt
,
626 make_number (pos
), !NILP (read
),
627 histvar
, histpos
, default_value
);
628 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (default_value
))
633 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
634 "Return a Lisp object read using the minibuffer.\n\
635 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
636 is a string to insert in the minibuffer before reading.")
637 (prompt
, initial_contents
)
638 Lisp_Object prompt
, initial_contents
;
640 CHECK_STRING (prompt
, 0);
641 if (!NILP (initial_contents
))
642 CHECK_STRING (initial_contents
, 1);
643 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
644 prompt
, Qnil
, 1, Qminibuffer_history
,
645 make_number (0), Qnil
);
648 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
649 "Return value of Lisp expression read using the minibuffer.\n\
650 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
651 is a string to insert in the minibuffer before reading.")
652 (prompt
, initial_contents
)
653 Lisp_Object prompt
, initial_contents
;
655 return Feval (Fread_minibuffer (prompt
, initial_contents
));
658 /* Functions that use the minibuffer to read various things. */
660 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 4, 0,
661 "Read a string from the minibuffer, prompting with string PROMPT.\n\
662 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
663 The third arg HISTORY, if non-nil, specifies a history list\n\
664 and optionally the initial position in the list.\n\
665 See `read-from-minibuffer' for details of HISTORY argument.")
666 (prompt
, initial_input
, history
, default_value
)
667 Lisp_Object prompt
, initial_input
, history
, default_value
;
669 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
,
670 Qnil
, history
, default_value
);
673 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 2, 0,
674 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
675 Prompt with PROMPT, and provide INIT as an initial value of the input string.")
677 Lisp_Object prompt
, init
;
679 CHECK_STRING (prompt
, 0);
681 CHECK_STRING (init
, 1);
683 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
,
684 0, Qminibuffer_history
, make_number (0), Qnil
);
687 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 2, 0,
688 "Read the name of a command and return as a symbol.\n\
689 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
690 (prompt
, default_value
)
691 Lisp_Object prompt
, default_value
;
693 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
,
694 Qnil
, Qnil
, default_value
),
699 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
700 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
701 Prompts with PROMPT.")
705 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
, Qnil
),
710 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 2, 0,
711 "Read the name of a user variable and return it as a symbol.\n\
712 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
713 A user variable is one whose documentation starts with a `*' character.")
714 (prompt
, default_value
)
715 Lisp_Object prompt
, default_value
;
717 return Fintern (Fcompleting_read (prompt
, Vobarray
,
718 Quser_variable_p
, Qt
,
719 Qnil
, Qnil
, default_value
),
723 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
724 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
725 Prompts with PROMPT.\n\
726 Optional second arg DEF is value to return if user enters an empty line.\n\
727 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
728 (prompt
, def
, require_match
)
729 Lisp_Object prompt
, def
, require_match
;
735 def
= XBUFFER (def
)->name
;
738 args
[0] = build_string ("%s(default %s) ");
741 prompt
= Fformat (3, args
);
743 return Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
,
744 require_match
, Qnil
, Qnil
, def
);
747 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
748 "Return common substring of all completions of STRING in ALIST.\n\
749 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
750 All that match are compared together; the longest initial sequence\n\
751 common to all matches is returned as a string.\n\
752 If there is no match at all, nil is returned.\n\
753 For an exact match, t is returned.\n\
755 ALIST can be an obarray instead of an alist.\n\
756 Then the print names of all symbols in the obarray are the possible matches.\n\
758 ALIST can also be a function to do the completion itself.\n\
759 It receives three arguments: the values STRING, PREDICATE and nil.\n\
760 Whatever it returns becomes the value of `try-completion'.\n\
762 If optional third argument PREDICATE is non-nil,\n\
763 it is used to test each possible match.\n\
764 The match is a candidate only if PREDICATE returns non-nil.\n\
765 The argument given to PREDICATE is the alist element\n\
766 or the symbol from the obarray.")
767 (string
, alist
, predicate
)
768 Lisp_Object string
, alist
, predicate
;
770 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
772 int compare
, matchsize
;
773 int list
= CONSP (alist
) || NILP (alist
);
776 Lisp_Object bucket
, zero
, end
, tem
;
777 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
779 CHECK_STRING (string
, 0);
780 if (!list
&& !VECTORP (alist
))
781 return call3 (alist
, string
, predicate
, Qnil
);
785 /* If ALIST is not a list, set TAIL just for gc pro. */
790 obsize
= XVECTOR (alist
)->size
;
791 bucket
= XVECTOR (alist
)->contents
[index
];
796 /* Get the next element of the alist or obarray. */
797 /* Exit the loop if the elements are all used up. */
798 /* elt gets the alist element or symbol.
799 eltstring gets the name to check as a completion. */
806 eltstring
= Fcar (elt
);
811 if (XFASTINT (bucket
) != 0)
814 eltstring
= Fsymbol_name (elt
);
815 if (XSYMBOL (bucket
)->next
)
816 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
818 XSETFASTINT (bucket
, 0);
820 else if (++index
>= obsize
)
824 bucket
= XVECTOR (alist
)->contents
[index
];
829 /* Is this element a possible completion? */
831 if (STRINGP (eltstring
)
832 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
833 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
834 XSTRING (string
)->size
))
839 XSETFASTINT (zero
, 0);
841 /* Ignore this element if it fails to match all the regexps. */
842 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
843 regexps
= XCONS (regexps
)->cdr
)
845 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
852 /* Ignore this element if there is a predicate
853 and the predicate doesn't like it. */
855 if (!NILP (predicate
))
857 if (EQ (predicate
, Qcommandp
))
858 tem
= Fcommandp (elt
);
861 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
862 tem
= call1 (predicate
, elt
);
865 if (NILP (tem
)) continue;
868 /* Update computation of how much all possible completions match */
871 if (NILP (bestmatch
))
872 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
875 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
876 matchsize
= scmp (XSTRING (bestmatch
)->data
,
877 XSTRING (eltstring
)->data
,
881 if (completion_ignore_case
)
883 /* If this is an exact match except for case,
884 use it as the best match rather than one that is not an
885 exact match. This way, we get the case pattern
886 of the actual match. */
887 if ((matchsize
== XSTRING (eltstring
)->size
888 && matchsize
< XSTRING (bestmatch
)->size
)
890 /* If there is more than one exact match ignoring case,
891 and one of them is exact including case,
893 /* If there is no exact match ignoring case,
894 prefer a match that does not change the case
896 ((matchsize
== XSTRING (eltstring
)->size
)
898 (matchsize
== XSTRING (bestmatch
)->size
)
899 && !bcmp (XSTRING (eltstring
)->data
,
900 XSTRING (string
)->data
, XSTRING (string
)->size
)
901 && bcmp (XSTRING (bestmatch
)->data
,
902 XSTRING (string
)->data
, XSTRING (string
)->size
)))
903 bestmatch
= eltstring
;
905 bestmatchsize
= matchsize
;
910 if (NILP (bestmatch
))
911 return Qnil
; /* No completions found */
912 /* If we are ignoring case, and there is no exact match,
913 and no additional text was supplied,
914 don't change the case of what the user typed. */
915 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
916 && XSTRING (bestmatch
)->size
> bestmatchsize
)
919 /* Return t if the supplied string is an exact match (counting case);
920 it does not require any change to be made. */
921 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
922 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
926 XSETFASTINT (zero
, 0); /* Else extract the part in which */
927 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
928 return Fsubstring (bestmatch
, zero
, end
);
931 /* Compare exactly LEN chars of strings at S1 and S2,
932 ignoring case if appropriate.
933 Return -1 if strings match,
934 else number of chars that match at the beginning. */
938 register unsigned char *s1
, *s2
;
941 register int l
= len
;
942 register unsigned char *start
= s1
;
944 if (completion_ignore_case
)
946 while (l
&& EQ (DOWNCASE (*s1
++), DOWNCASE (*s2
++)))
951 while (l
&& *s1
++ == *s2
++)
960 /* Now *--S1 is the unmatching byte. If it is in the middle of
961 multi-byte form, we must say that the multi-byte character
962 there doesn't match. */
963 while (match
&& *--s1
>= 0xA0) match
--;
968 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
969 "Search for partial matches to STRING in ALIST.\n\
970 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
971 The value is a list of all the strings from ALIST that match.\n\
973 ALIST can be an obarray instead of an alist.\n\
974 Then the print names of all symbols in the obarray are the possible matches.\n\
976 ALIST can also be a function to do the completion itself.\n\
977 It receives three arguments: the values STRING, PREDICATE and t.\n\
978 Whatever it returns becomes the value of `all-completion'.\n\
980 If optional third argument PREDICATE is non-nil,\n\
981 it is used to test each possible match.\n\
982 The match is a candidate only if PREDICATE returns non-nil.\n\
983 The argument given to PREDICATE is the alist element\n\
984 or the symbol from the obarray.\n\
986 If the optional fourth argument HIDE-SPACES is non-nil,\n\
987 strings in ALIST that start with a space\n\
988 are ignored unless STRING itself starts with a space.")
989 (string
, alist
, predicate
, hide_spaces
)
990 Lisp_Object string
, alist
, predicate
, hide_spaces
;
992 Lisp_Object tail
, elt
, eltstring
;
993 Lisp_Object allmatches
;
994 int list
= CONSP (alist
) || NILP (alist
);
996 Lisp_Object bucket
, tem
;
997 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
999 CHECK_STRING (string
, 0);
1000 if (!list
&& !VECTORP (alist
))
1002 return call3 (alist
, string
, predicate
, Qt
);
1006 /* If ALIST is not a list, set TAIL just for gc pro. */
1011 obsize
= XVECTOR (alist
)->size
;
1012 bucket
= XVECTOR (alist
)->contents
[index
];
1017 /* Get the next element of the alist or obarray. */
1018 /* Exit the loop if the elements are all used up. */
1019 /* elt gets the alist element or symbol.
1020 eltstring gets the name to check as a completion. */
1027 eltstring
= Fcar (elt
);
1032 if (XFASTINT (bucket
) != 0)
1035 eltstring
= Fsymbol_name (elt
);
1036 if (XSYMBOL (bucket
)->next
)
1037 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
1039 XSETFASTINT (bucket
, 0);
1041 else if (++index
>= obsize
)
1045 bucket
= XVECTOR (alist
)->contents
[index
];
1050 /* Is this element a possible completion? */
1052 if (STRINGP (eltstring
)
1053 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1054 /* If HIDE_SPACES, reject alternatives that start with space
1055 unless the input starts with space. */
1056 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
1057 || XSTRING (eltstring
)->data
[0] != ' '
1058 || NILP (hide_spaces
))
1059 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1060 XSTRING (string
)->size
))
1063 Lisp_Object regexps
;
1065 XSETFASTINT (zero
, 0);
1067 /* Ignore this element if it fails to match all the regexps. */
1068 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1069 regexps
= XCONS (regexps
)->cdr
)
1071 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1075 if (CONSP (regexps
))
1078 /* Ignore this element if there is a predicate
1079 and the predicate doesn't like it. */
1081 if (!NILP (predicate
))
1083 if (EQ (predicate
, Qcommandp
))
1084 tem
= Fcommandp (elt
);
1087 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1088 tem
= call1 (predicate
, elt
);
1091 if (NILP (tem
)) continue;
1093 /* Ok => put it on the list. */
1094 allmatches
= Fcons (eltstring
, allmatches
);
1098 return Fnreverse (allmatches
);
1101 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1102 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1103 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1105 /* This comment supplies the doc string for completing-read,
1106 for make-docfile to see. We cannot put this in the real DEFUN
1107 due to limits in the Unix cpp.
1109 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 7, 0,
1110 "Read a string in the minibuffer, with completion.\n\
1111 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1112 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1113 PREDICATE limits completion to a subset of TABLE.\n\
1114 See `try-completion' and `all-completions' for more details
1115 on completion, TABLE, and PREDICATE.\n\
1117 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1118 the input is (or completes to) an element of TABLE or is null.\n\
1119 If it is also not t, Return does not exit if it does non-null completion.\n\
1120 If the input is null, `completing-read' returns an empty string,\n\
1121 regardless of the value of REQUIRE-MATCH.\n\
1123 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1124 If it is (STRING . POSITION), the initial input\n\
1125 is STRING, but point is placed POSITION characters into the string.\n\
1126 HIST, if non-nil, specifies a history list\n\
1127 and optionally the initial position in the list.\n\
1128 It can be a symbol, which is the history list variable to use,\n\
1129 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1130 In that case, HISTVAR is the history list variable to use,\n\
1131 and HISTPOS is the initial position (the position in the list\n\
1132 which INITIAL-CONTENTS corresponds to).\n\
1133 Positions are counted starting from 1 at the beginning of the list.\n\
1134 DEF, if non-nil, is the default value.
1136 Completion ignores case if the ambient value of\n\
1137 `completion-ignore-case' is non-nil."
1139 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 7, 0,
1140 0 /* See immediately above */)
1141 (prompt
, table
, predicate
, require_match
, init
, hist
, def
)
1142 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
, def
;
1144 Lisp_Object val
, histvar
, histpos
, position
;
1146 int count
= specpdl_ptr
- specpdl
;
1147 specbind (Qminibuffer_completion_table
, table
);
1148 specbind (Qminibuffer_completion_predicate
, predicate
);
1149 specbind (Qminibuffer_completion_confirm
,
1150 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1151 last_exact_completion
= Qnil
;
1158 position
= Fcdr (init
);
1161 CHECK_STRING (init
, 0);
1162 if (!NILP (position
))
1164 CHECK_NUMBER (position
, 0);
1165 /* Convert to distance from end of input. */
1166 pos
= XINT (position
) - XSTRING (init
)->size
;
1177 histvar
= Fcar_safe (hist
);
1178 histpos
= Fcdr_safe (hist
);
1181 histvar
= Qminibuffer_history
;
1183 XSETFASTINT (histpos
, 0);
1185 val
= read_minibuf (NILP (require_match
)
1186 ? Vminibuffer_local_completion_map
1187 : Vminibuffer_local_must_match_map
,
1188 init
, prompt
, make_number (pos
), 0,
1189 histvar
, histpos
, def
);
1190 if (STRINGP (val
) && XSTRING (val
)->size
== 0 && ! NILP (def
))
1192 return unbind_to (count
, val
);
1195 Lisp_Object
Fminibuffer_completion_help ();
1196 Lisp_Object
assoc_for_completion ();
1197 /* A subroutine of Fintern_soft. */
1198 extern Lisp_Object
oblookup ();
1201 /* Test whether TXT is an exact completion. */
1203 test_completion (txt
)
1208 if (CONSP (Vminibuffer_completion_table
)
1209 || NILP (Vminibuffer_completion_table
))
1210 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1211 else if (VECTORP (Vminibuffer_completion_table
))
1213 /* Bypass intern-soft as that loses for nil */
1214 tem
= oblookup (Vminibuffer_completion_table
,
1215 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1218 else if (!NILP (Vminibuffer_completion_predicate
))
1219 return call1 (Vminibuffer_completion_predicate
, tem
);
1224 return call3 (Vminibuffer_completion_table
, txt
,
1225 Vminibuffer_completion_predicate
, Qlambda
);
1229 * 0 no possible completion
1230 * 1 was already an exact and unique completion
1231 * 3 was already an exact completion
1232 * 4 completed to an exact completion
1233 * 5 some completion happened
1234 * 6 no completion happened
1239 Lisp_Object completion
, tem
;
1242 struct gcpro gcpro1
, gcpro2
;
1244 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1245 Vminibuffer_completion_predicate
);
1246 last
= last_exact_completion
;
1247 last_exact_completion
= Qnil
;
1249 GCPRO2 (completion
, last
);
1251 if (NILP (completion
))
1254 temp_echo_area_glyphs (" [No match]");
1259 if (EQ (completion
, Qt
)) /* exact and unique match */
1266 tem
= Fstring_equal (completion
, Fbuffer_string());
1267 if (completedp
= NILP (tem
))
1269 Ferase_buffer (); /* Some completion happened */
1270 Finsert (1, &completion
);
1273 /* It did find a match. Do we match some possibility exactly now? */
1274 tem
= test_completion (Fbuffer_string ());
1277 /* not an exact match */
1282 Fminibuffer_completion_help ();
1284 temp_echo_area_glyphs (" [Next char not unique]");
1287 else if (completedp
)
1292 /* If the last exact completion and this one were the same,
1293 it means we've already given a "Complete but not unique"
1294 message and the user's hit TAB again, so now we give him help. */
1295 last_exact_completion
= completion
;
1298 tem
= Fbuffer_string ();
1299 if (!NILP (Fequal (tem
, last
)))
1300 Fminibuffer_completion_help ();
1306 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1309 assoc_for_completion (key
, list
)
1310 register Lisp_Object key
;
1313 register Lisp_Object tail
;
1315 if (completion_ignore_case
)
1316 key
= Fupcase (key
);
1318 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1320 register Lisp_Object elt
, tem
, thiscar
;
1322 if (!CONSP (elt
)) continue;
1323 thiscar
= Fcar (elt
);
1324 if (!STRINGP (thiscar
))
1326 if (completion_ignore_case
)
1327 thiscar
= Fupcase (thiscar
);
1328 tem
= Fequal (thiscar
, key
);
1329 if (!NILP (tem
)) return elt
;
1335 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1336 "Complete the minibuffer contents as far as possible.\n\
1337 Return nil if there is no valid completion, else t.\n\
1338 If no characters can be completed, display a list of possible completions.\n\
1339 If you repeat this command after it displayed such a list,\n\
1340 scroll the window of possible completions.")
1344 Lisp_Object window
, tem
;
1346 /* If the previous command was not this, then mark the completion
1348 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1349 Vminibuf_scroll_window
= Qnil
;
1351 window
= Vminibuf_scroll_window
;
1352 /* If there's a fresh completion window with a live buffer,
1353 and this command is repeated, scroll that window. */
1354 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1355 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1357 struct buffer
*obuf
= current_buffer
;
1359 Fset_buffer (XWINDOW (window
)->buffer
);
1360 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1362 /* If end is in view, scroll up to the beginning. */
1363 Fset_window_start (window
, BEGV
, Qnil
);
1365 /* Else scroll down one screen. */
1366 Fscroll_other_window (Qnil
);
1368 set_buffer_internal (obuf
);
1372 i
= do_completion ();
1379 temp_echo_area_glyphs (" [Sole completion]");
1383 temp_echo_area_glyphs (" [Complete, but not unique]");
1390 /* Subroutines of Fminibuffer_complete_and_exit. */
1392 /* This one is called by internal_condition_case to do the real work. */
1395 complete_and_exit_1 ()
1397 return make_number (do_completion ());
1400 /* This one is called by internal_condition_case if an error happens.
1401 Pretend the current value is an exact match. */
1404 complete_and_exit_2 (ignore
)
1407 return make_number (1);
1410 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1411 Sminibuffer_complete_and_exit
, 0, 0, "",
1412 "If the minibuffer contents is a valid completion then exit.\n\
1413 Otherwise try to complete it. If completion leads to a valid completion,\n\
1414 a repetition of this command will exit.")
1420 /* Allow user to specify null string */
1424 if (!NILP (test_completion (Fbuffer_string ())))
1427 /* Call do_completion, but ignore errors. */
1428 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1429 complete_and_exit_2
);
1439 if (!NILP (Vminibuffer_completion_confirm
))
1441 temp_echo_area_glyphs (" [Confirm]");
1451 Fthrow (Qexit
, Qnil
);
1455 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1457 "Complete the minibuffer contents at most a single word.\n\
1458 After one word is completed as much as possible, a space or hyphen\n\
1459 is added, provided that matches some possible completion.\n\
1460 Return nil if there is no valid completion, else t.")
1463 Lisp_Object completion
, tem
;
1465 register unsigned char *completion_string
;
1466 struct gcpro gcpro1
, gcpro2
;
1468 /* We keep calling Fbuffer_string rather than arrange for GC to
1469 hold onto a pointer to one of the strings thus made. */
1471 completion
= Ftry_completion (Fbuffer_string (),
1472 Vminibuffer_completion_table
,
1473 Vminibuffer_completion_predicate
);
1474 if (NILP (completion
))
1477 temp_echo_area_glyphs (" [No match]");
1480 if (EQ (completion
, Qt
))
1483 #if 0 /* How the below code used to look, for reference. */
1484 tem
= Fbuffer_string ();
1485 b
= XSTRING (tem
)->data
;
1486 i
= ZV
- 1 - XSTRING (completion
)->size
;
1487 p
= XSTRING (completion
)->data
;
1489 0 <= scmp (b
, p
, ZV
- 1))
1492 /* Set buffer to longest match of buffer tail and completion head. */
1493 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1495 del_range (1, i
+ 1);
1498 #else /* Rewritten code */
1500 register unsigned char *buffer_string
;
1501 int buffer_length
, completion_length
;
1503 CHECK_STRING (completion
, 0);
1504 tem
= Fbuffer_string ();
1505 GCPRO2 (completion
, tem
);
1506 /* If reading a file name,
1507 expand any $ENVVAR refs in the buffer and in TEM. */
1508 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1510 Lisp_Object substituted
;
1511 substituted
= Fsubstitute_in_file_name (tem
);
1512 if (! EQ (substituted
, tem
))
1516 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1519 buffer_string
= XSTRING (tem
)->data
;
1520 completion_string
= XSTRING (completion
)->data
;
1521 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1522 completion_length
= XSTRING (completion
)->size
;
1523 i
= buffer_length
- completion_length
;
1524 /* Mly: I don't understand what this is supposed to do AT ALL */
1526 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1528 /* Set buffer to longest match of buffer tail and completion head. */
1532 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1534 del_range (1, i
+ 1);
1539 #endif /* Rewritten code */
1542 /* If completion finds next char not unique,
1543 consider adding a space or a hyphen. */
1544 if (i
== XSTRING (completion
)->size
)
1546 GCPRO1 (completion
);
1547 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1548 Vminibuffer_completion_table
,
1549 Vminibuffer_completion_predicate
);
1556 GCPRO1 (completion
);
1558 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1559 Vminibuffer_completion_table
,
1560 Vminibuffer_completion_predicate
);
1568 /* Now find first word-break in the stuff found by completion.
1569 i gets index in string of where to stop completing. */
1573 completion_string
= XSTRING (completion
)->data
;
1574 for (; i
< XSTRING (completion
)->size
; i
+= len
)
1576 c
= STRING_CHAR_AND_LENGTH (completion_string
+ i
,
1577 XSTRING (completion
)->size
- i
,
1579 if (SYNTAX (c
) != Sword
)
1587 /* If got no characters, print help for user. */
1592 Fminibuffer_completion_help ();
1596 /* Otherwise insert in minibuffer the chars we got */
1599 insert_from_string (completion
, 0, i
, 1);
1603 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1605 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1606 Each element may be just a symbol or string\n\
1607 or may be a list of two strings to be printed as if concatenated.\n\
1608 `standard-output' must be a buffer.\n\
1609 At the end, run the normal hook `completion-setup-hook'.\n\
1610 It can find the completion buffer in `standard-output'.")
1612 Lisp_Object completions
;
1614 Lisp_Object tail
, elt
;
1617 struct gcpro gcpro1
, gcpro2
;
1618 struct buffer
*old
= current_buffer
;
1621 /* Note that (when it matters) every variable
1622 points to a non-string that is pointed to by COMPLETIONS,
1623 except for ELT. ELT can be pointing to a string
1624 when terpri or Findent_to calls a change hook. */
1626 GCPRO2 (completions
, elt
);
1628 if (BUFFERP (Vstandard_output
))
1629 set_buffer_internal (XBUFFER (Vstandard_output
));
1631 if (NILP (completions
))
1632 write_string ("There are no possible completions of what you have typed.",
1636 write_string ("Possible completions are:", -1);
1637 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1641 Lisp_Object startpos
, endpos
;
1644 /* Compute the length of this element. */
1648 CHECK_STRING (tem
, 0);
1649 length
= XSTRING (tem
)->size
;
1651 tem
= Fcar (XCDR (elt
));
1652 CHECK_STRING (tem
, 0);
1653 length
+= XSTRING (tem
)->size
;
1657 CHECK_STRING (elt
, 0);
1658 length
= XSTRING (elt
)->size
;
1661 /* This does a bad job for narrower than usual windows.
1662 Sadly, the window it will appear in is not known
1663 until after the text has been made. */
1665 if (BUFFERP (Vstandard_output
))
1666 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1668 /* If the previous completion was very wide,
1669 or we have two on this line already,
1670 don't put another on the same line. */
1671 if (column
> 33 || first
1672 /* If this is really wide, don't put it second on a line. */
1673 || column
> 0 && length
> 45)
1678 /* Otherwise advance to column 35. */
1681 if (BUFFERP (Vstandard_output
))
1683 tem
= Findent_to (make_number (35), make_number (2));
1685 column
= XINT (tem
);
1691 write_string (" ", -1);
1694 while (column
< 35);
1698 if (BUFFERP (Vstandard_output
))
1700 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1701 Fset_text_properties (startpos
, endpos
,
1702 Qnil
, Vstandard_output
);
1705 /* Output this element and update COLUMN. */
1708 Fprinc (Fcar (elt
), Qnil
);
1709 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1716 /* If output is to a buffer, recompute COLUMN in a way
1717 that takes account of character widths. */
1718 if (BUFFERP (Vstandard_output
))
1720 tem
= Fcurrent_column ();
1721 column
= XINT (tem
);
1730 if (BUFFERP (Vstandard_output
))
1731 set_buffer_internal (old
);
1733 if (!NILP (Vrun_hooks
))
1734 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1739 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1741 "Display a list of possible completions of the current minibuffer contents.")
1744 Lisp_Object completions
;
1746 message ("Making completion list...");
1747 completions
= Fall_completions (Fbuffer_string (),
1748 Vminibuffer_completion_table
,
1749 Vminibuffer_completion_predicate
,
1751 echo_area_glyphs
= 0;
1753 if (NILP (completions
))
1756 temp_echo_area_glyphs (" [No completions]");
1759 internal_with_output_to_temp_buffer ("*Completions*",
1760 Fdisplay_completion_list
,
1761 Fsort (completions
, Qstring_lessp
));
1765 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1766 "Terminate minibuffer input.")
1769 if (INTEGERP (last_command_char
))
1770 internal_self_insert (last_command_char
, 0);
1774 Fthrow (Qexit
, Qnil
);
1777 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1778 "Terminate this minibuffer argument.")
1781 Fthrow (Qexit
, Qnil
);
1784 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1785 "Return current depth of activations of minibuffer, a nonnegative integer.")
1788 return make_number (minibuf_level
);
1791 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1792 "Return the prompt string of the currently-active minibuffer.\n\
1793 If no minibuffer is active, return nil.")
1796 return Fcopy_sequence (minibuf_prompt
);
1799 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1800 Sminibuffer_prompt_width
, 0, 0, 0,
1801 "Return the display width of the minibuffer prompt.")
1805 XSETFASTINT (width
, minibuf_prompt_width
);
1809 /* Temporarily display the string M at the end of the current
1810 minibuffer contents. This is used to display things like
1811 "[No Match]" when the user requests a completion for a prefix
1812 that has no possible completions, and other quick, unobtrusive
1815 temp_echo_area_glyphs (m
)
1820 Lisp_Object oinhibit
;
1821 oinhibit
= Vinhibit_quit
;
1823 /* Clear out any old echo-area message to make way for our new thing. */
1830 Fsit_for (make_number (2), Qnil
, Qnil
);
1831 del_range (osize
, ZV
);
1833 if (!NILP (Vquit_flag
))
1836 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1838 Vinhibit_quit
= oinhibit
;
1841 DEFUN ("minibuffer-message", Fminibuffer_message
, Sminibuffer_message
,
1843 "Temporarily display STRING at the end of the minibuffer.\n\
1844 The text is displayed for two seconds,\n\
1845 or until the next input event arrives, whichever comes first.")
1849 temp_echo_area_glyphs (XSTRING (string
)->data
);
1853 init_minibuf_once ()
1855 Vminibuffer_list
= Qnil
;
1856 staticpro (&Vminibuffer_list
);
1862 minibuf_prompt
= Qnil
;
1863 staticpro (&minibuf_prompt
);
1865 minibuf_save_list
= Qnil
;
1866 staticpro (&minibuf_save_list
);
1868 Qread_file_name_internal
= intern ("read-file-name-internal");
1869 staticpro (&Qread_file_name_internal
);
1871 Qminibuffer_default
= intern ("minibuffer-default");
1872 staticpro (&Qminibuffer_default
);
1873 Fset (Qminibuffer_default
, Qnil
);
1875 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1876 staticpro (&Qminibuffer_completion_table
);
1878 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1879 staticpro (&Qminibuffer_completion_confirm
);
1881 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1882 staticpro (&Qminibuffer_completion_predicate
);
1884 staticpro (&last_exact_completion
);
1885 last_exact_completion
= Qnil
;
1887 staticpro (&last_minibuf_string
);
1888 last_minibuf_string
= Qnil
;
1890 Quser_variable_p
= intern ("user-variable-p");
1891 staticpro (&Quser_variable_p
);
1893 Qminibuffer_history
= intern ("minibuffer-history");
1894 staticpro (&Qminibuffer_history
);
1896 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1897 staticpro (&Qminibuffer_setup_hook
);
1899 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1900 staticpro (&Qminibuffer_exit_hook
);
1902 Qhistory_length
= intern ("history-length");
1903 staticpro (&Qhistory_length
);
1905 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1906 "Normal hook run just after entry to minibuffer.");
1907 Vminibuffer_setup_hook
= Qnil
;
1909 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1910 "Normal hook run just after exit from minibuffer.");
1911 Vminibuffer_exit_hook
= Qnil
;
1913 DEFVAR_LISP ("history-length", &Vhistory_length
,
1914 "*Maximum length for history lists before truncation takes place.\n\
1915 A number means that length; t means infinite. Truncation takes place\n\
1916 just after a new element is inserted. Setting the history-length\n\
1917 property of a history variable overrides this default.");
1918 XSETFASTINT (Vhistory_length
, 30);
1920 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1921 "*Non-nil means automatically provide help for invalid completion input.");
1924 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
1925 "Non-nil means don't consider case significant in completion.");
1926 completion_ignore_case
= 0;
1928 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
1929 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1930 More precisely, this variable makes a difference when the minibuffer window\n\
1931 is the selected window. If you are in some other window, minibuffer commands\n\
1932 are allowed even if a minibuffer is active.");
1933 enable_recursive_minibuffers
= 0;
1935 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
1936 "Alist or obarray used for completion in the minibuffer.\n\
1937 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1939 The value may alternatively be a function, which is given three arguments:\n\
1940 STRING, the current buffer contents;\n\
1941 PREDICATE, the predicate for filtering possible matches;\n\
1942 CODE, which says what kind of things to do.\n\
1943 CODE can be nil, t or `lambda'.\n\
1944 nil means to return the best completion of STRING, or nil if there is none.\n\
1945 t means to return a list of all possible completions of STRING.\n\
1946 `lambda' means to return t if STRING is a valid completion as it stands.");
1947 Vminibuffer_completion_table
= Qnil
;
1949 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
1950 "Within call to `completing-read', this holds the PREDICATE argument.");
1951 Vminibuffer_completion_predicate
= Qnil
;
1953 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
1954 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1955 Vminibuffer_completion_confirm
= Qnil
;
1957 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
1958 "Value that `help-form' takes on inside the minibuffer.");
1959 Vminibuffer_help_form
= Qnil
;
1961 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
1962 "History list symbol to add minibuffer values to.\n\
1963 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
1965 (set minibuffer-history-variable\n\
1966 (cons STRING (symbol-value minibuffer-history-variable)))");
1967 XSETFASTINT (Vminibuffer_history_variable
, 0);
1969 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
1970 "Current position of redoing in the history list.");
1971 Vminibuffer_history_position
= Qnil
;
1973 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
1974 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
1975 Some uses of the echo area also raise that frame (since they use it too).");
1976 minibuffer_auto_raise
= 0;
1978 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
1979 "List of regexps that should restrict possible completions.");
1980 Vcompletion_regexp_list
= Qnil
;
1982 defsubr (&Sset_minibuffer_window
);
1983 defsubr (&Sread_from_minibuffer
);
1984 defsubr (&Seval_minibuffer
);
1985 defsubr (&Sread_minibuffer
);
1986 defsubr (&Sread_string
);
1987 defsubr (&Sread_command
);
1988 defsubr (&Sread_variable
);
1989 defsubr (&Sread_buffer
);
1990 defsubr (&Sread_no_blanks_input
);
1991 defsubr (&Sminibuffer_depth
);
1992 defsubr (&Sminibuffer_prompt
);
1993 defsubr (&Sminibuffer_prompt_width
);
1995 defsubr (&Stry_completion
);
1996 defsubr (&Sall_completions
);
1997 defsubr (&Scompleting_read
);
1998 defsubr (&Sminibuffer_complete
);
1999 defsubr (&Sminibuffer_complete_word
);
2000 defsubr (&Sminibuffer_complete_and_exit
);
2001 defsubr (&Sdisplay_completion_list
);
2002 defsubr (&Sminibuffer_completion_help
);
2004 defsubr (&Sself_insert_and_exit
);
2005 defsubr (&Sexit_minibuffer
);
2007 defsubr (&Sminibuffer_message
);
2012 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
2013 "abort-recursive-edit");
2014 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
2016 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
2019 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
2020 "abort-recursive-edit");
2021 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
2023 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
2026 initial_define_key (Vminibuffer_local_ns_map
, ' ',
2028 initial_define_key (Vminibuffer_local_ns_map
, '\t',
2030 initial_define_key (Vminibuffer_local_ns_map
, '?',
2031 "self-insert-and-exit");
2033 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
2034 "abort-recursive-edit");
2035 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
2037 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
2040 initial_define_key (Vminibuffer_local_completion_map
, '\t',
2041 "minibuffer-complete");
2042 initial_define_key (Vminibuffer_local_completion_map
, ' ',
2043 "minibuffer-complete-word");
2044 initial_define_key (Vminibuffer_local_completion_map
, '?',
2045 "minibuffer-completion-help");
2047 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
2048 "abort-recursive-edit");
2049 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
2050 "minibuffer-complete-and-exit");
2051 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
2052 "minibuffer-complete-and-exit");
2053 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
2054 "minibuffer-complete");
2055 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
2056 "minibuffer-complete-word");
2057 initial_define_key (Vminibuffer_local_must_match_map
, '?',
2058 "minibuffer-completion-help");