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. */
26 #include "dispextern.h"
32 #define min(a, b) ((a) < (b) ? (a) : (b))
36 /* List of buffers for use as minibuffers.
37 The first element of the list is used for the outermost minibuffer
38 invocation, the next element is used for a recursive minibuffer
39 invocation, etc. The list is extended at the end as deeper
40 minibuffer recursions are encountered. */
41 Lisp_Object Vminibuffer_list
;
43 /* Data to remember during recursive minibuffer invocations */
44 Lisp_Object minibuf_save_list
;
46 /* Depth in minibuffer invocations. */
49 /* Nonzero means display completion help for invalid input. */
52 /* The maximum length of a minibuffer history. */
53 Lisp_Object Qhistory_length
, Vhistory_length
;
55 /* Fread_minibuffer leaves the input here as a string. */
56 Lisp_Object last_minibuf_string
;
58 /* Nonzero means let functions called when within a minibuffer
59 invoke recursive minibuffers (to read arguments, or whatever) */
60 int enable_recursive_minibuffers
;
62 /* help-form is bound to this while in the minibuffer. */
64 Lisp_Object Vminibuffer_help_form
;
66 /* Variable which is the history list to add minibuffer values to. */
68 Lisp_Object Vminibuffer_history_variable
;
70 /* Current position in the history list (adjusted by M-n and M-p). */
72 Lisp_Object Vminibuffer_history_position
;
74 Lisp_Object Qminibuffer_history
;
76 Lisp_Object Qread_file_name_internal
;
78 /* Normal hooks for entry to and exit from minibuffer. */
80 Lisp_Object Qminibuffer_setup_hook
, Vminibuffer_setup_hook
;
81 Lisp_Object Qminibuffer_exit_hook
, Vminibuffer_exit_hook
;
83 /* Nonzero means completion ignores case. */
85 int completion_ignore_case
;
87 /* List of regexps that should restrict possible completions. */
89 Lisp_Object Vcompletion_regexp_list
;
91 /* Nonzero means raise the minibuffer frame when the minibuffer
94 int minibuffer_auto_raise
;
96 /* If last completion attempt reported "Complete but not unique"
97 then this is the string completed then; otherwise this is nil. */
99 static Lisp_Object last_exact_completion
;
101 Lisp_Object Quser_variable_p
;
103 /* Non-nil means it is the window for C-M-v to scroll
104 when the minibuffer is selected. */
105 extern Lisp_Object Vminibuf_scroll_window
;
107 extern Lisp_Object Voverriding_local_map
;
109 /* Put minibuf on currently selected frame's minibuffer.
110 We do this whenever the user starts a new minibuffer
111 or when a minibuffer exits. */
114 choose_minibuf_frame ()
116 if (selected_frame
!= 0
117 && !EQ (minibuf_window
, selected_frame
->minibuffer_window
))
119 /* I don't think that any frames may validly have a null minibuffer
121 if (NILP (selected_frame
->minibuffer_window
))
124 Fset_window_buffer (selected_frame
->minibuffer_window
,
125 XWINDOW (minibuf_window
)->buffer
);
126 minibuf_window
= selected_frame
->minibuffer_window
;
130 DEFUN ("set-minibuffer-window", Fset_minibuffer_window
,
131 Sset_minibuffer_window
, 1, 1, 0,
132 "Specify which minibuffer window to use for the minibuffer.\n\
133 This effects where the minibuffer is displayed if you put text in it\n\
134 without invoking the usual minibuffer commands.")
138 CHECK_WINDOW (window
, 1);
139 if (! MINI_WINDOW_P (XWINDOW (window
)))
140 error ("Window is not a minibuffer window");
142 minibuf_window
= window
;
148 /* Actual minibuffer invocation. */
150 void read_minibuf_unwind ();
151 Lisp_Object
get_minibuffer ();
152 Lisp_Object
read_minibuf ();
154 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
155 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
156 prompting with PROMPT (a string), using history list HISTVAR
157 with initial position HISTPOS. (BACKUP_N should be <= 0.)
159 Normally return the result as a string (the text that was read),
160 but if EXPFLAG is nonzero, read it and return the object read.
161 If HISTVAR is given, save the value read on that history only if it doesn't
162 match the front of that history list exactly. The value is pushed onto
163 the list as the string that was read. */
166 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
, histvar
, histpos
)
170 Lisp_Object backup_n
;
176 int count
= specpdl_ptr
- specpdl
;
177 Lisp_Object mini_frame
, ambient_dir
;
178 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
180 single_kboard_state ();
183 ambient_dir
= current_buffer
->directory
;
185 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
186 store them away before we can GC. Don't need to protect
187 BACKUP_N because we use the value only if it is an integer. */
188 GCPRO4 (map
, initial
, val
, ambient_dir
);
190 if (!STRINGP (prompt
))
191 prompt
= build_string ("");
193 if (!enable_recursive_minibuffers
194 && minibuf_level
> 0)
196 if (EQ (selected_window
, minibuf_window
))
197 error ("Command attempted to use minibuffer while in minibuffer");
199 /* If we're in another window, cancel the minibuffer that's active. */
201 build_string ("Command attempted to use minibuffer while in minibuffer"));
204 /* Choose the minibuffer window and frame, and take action on them. */
206 choose_minibuf_frame ();
208 record_unwind_protect (Fset_window_configuration
,
209 Fcurrent_window_configuration (Qnil
));
211 /* If the minibuffer window is on a different frame, save that
212 frame's configuration too. */
213 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
214 if (XFRAME (mini_frame
) != selected_frame
)
215 record_unwind_protect (Fset_window_configuration
,
216 Fcurrent_window_configuration (mini_frame
));
218 /* If the minibuffer is on an iconified or invisible frame,
219 make it visible now. */
220 Fmake_frame_visible (mini_frame
);
222 if (minibuffer_auto_raise
)
223 Fraise_frame (mini_frame
);
225 /* We have to do this after saving the window configuration
226 since that is what restores the current buffer. */
228 /* Arrange to restore a number of minibuffer-related variables.
229 We could bind each variable separately, but that would use lots of
232 = Fcons (Voverriding_local_map
,
233 Fcons (minibuf_window
, minibuf_save_list
));
235 = Fcons (minibuf_prompt
,
236 Fcons (make_number (minibuf_prompt_width
),
238 Fcons (Vcurrent_prefix_arg
,
239 Fcons (Vminibuffer_history_position
,
240 Fcons (Vminibuffer_history_variable
,
241 minibuf_save_list
))))));
243 record_unwind_protect (read_minibuf_unwind
, Qnil
);
246 /* Now that we can restore all those variables, start changing them. */
248 minibuf_prompt_width
= 0; /* xdisp.c puts in the right value. */
249 minibuf_prompt
= Fcopy_sequence (prompt
);
250 Vminibuffer_history_position
= histpos
;
251 Vminibuffer_history_variable
= histvar
;
252 Vhelp_form
= Vminibuffer_help_form
;
254 /* Switch to the minibuffer. */
256 Fset_buffer (get_minibuffer (minibuf_level
));
258 /* The current buffer's default directory is usually the right thing
259 for our minibuffer here. However, if you're typing a command at
260 a minibuffer-only frame when minibuf_level is zero, then buf IS
261 the current_buffer, so reset_buffer leaves buf's default
262 directory unchanged. This is a bummer when you've just started
263 up Emacs and buf's default directory is Qnil. Here's a hack; can
264 you think of something better to do? Find another buffer with a
265 better directory, and use that one instead. */
266 if (STRINGP (ambient_dir
))
267 current_buffer
->directory
= ambient_dir
;
270 Lisp_Object buf_list
;
272 for (buf_list
= Vbuffer_alist
;
274 buf_list
= XCONS (buf_list
)->cdr
)
276 Lisp_Object other_buf
;
278 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
279 if (STRINGP (XBUFFER (other_buf
)->directory
))
281 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
287 if (XFRAME (mini_frame
) != selected_frame
)
288 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
290 Vminibuf_scroll_window
= selected_window
;
291 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
292 Fselect_window (minibuf_window
);
293 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
295 Fmake_local_variable (Qprint_escape_newlines
);
296 print_escape_newlines
= 1;
298 /* Erase the buffer. */
300 int count1
= specpdl_ptr
- specpdl
;
301 specbind (Qinhibit_read_only
, Qt
);
303 unbind_to (count1
, Qnil
);
306 /* Put in the initial input. */
309 Finsert (1, &initial
);
310 if (!NILP (backup_n
) && INTEGERP (backup_n
))
311 Fforward_char (backup_n
);
314 echo_area_glyphs
= 0;
315 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
316 previous_echo_glyphs
= 0;
318 current_buffer
->keymap
= map
;
320 /* Run our hook, but not if it is empty.
321 (run-hooks would do nothing if it is empty,
322 but it's important to save time here in the usual case). */
323 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
324 && !NILP (Vrun_hooks
))
325 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
327 /* ??? MCC did redraw_screen here if switching screens. */
330 /* If cursor is on the minibuffer line,
331 show the user we have exited by putting it in column 0. */
332 if ((FRAME_CURSOR_Y (selected_frame
)
333 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
336 FRAME_CURSOR_X (selected_frame
)
337 = FRAME_LEFT_SCROLL_BAR_WIDTH (selected_frame
);
338 update_frame (selected_frame
, 1, 1);
341 /* Make minibuffer contents into a string */
342 val
= make_buffer_string (1, Z
, 1);
343 #if 0 /* make_buffer_string should handle the gap. */
344 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
347 /* VAL is the string of minibuffer text. */
348 last_minibuf_string
= val
;
350 /* Add the value to the appropriate history list unless it is empty. */
351 if (XSTRING (val
)->size
!= 0
352 && SYMBOLP (Vminibuffer_history_variable
)
353 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
355 /* If the caller wanted to save the value read on a history list,
356 then do so if the value is not already the front of the list. */
358 histval
= Fsymbol_value (Vminibuffer_history_variable
);
360 /* The value of the history variable must be a cons or nil. Other
361 values are unacceptable. We silently ignore these values. */
364 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
368 histval
= Fcons (last_minibuf_string
, histval
);
369 Fset (Vminibuffer_history_variable
, histval
);
371 /* Truncate if requested. */
372 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
373 if (NILP (length
)) length
= Vhistory_length
;
374 if (INTEGERP (length
)) {
375 if (XINT (length
) <= 0)
376 Fset (Vminibuffer_history_variable
, Qnil
);
381 temp
= Fnthcdr (Fsub1 (length
), histval
);
382 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
388 /* If Lisp form desired instead of string, parse it. */
391 Lisp_Object expr_and_pos
;
394 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
395 /* Ignore trailing whitespace; any other trailing junk is an error. */
396 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
397 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
398 error ("Trailing garbage following expression");
399 val
= Fcar (expr_and_pos
);
402 /* The appropriate frame will get selected
403 in set-window-configuration. */
404 RETURN_UNGCPRO (unbind_to (count
, val
));
407 /* Return a buffer to be used as the minibuffer at depth `depth'.
408 depth = 0 is the lowest allowed argument, and that is the value
409 used for nonrecursive minibuffer invocations */
412 get_minibuffer (depth
)
415 Lisp_Object tail
, num
, buf
;
417 extern Lisp_Object
nconc2 ();
419 XSETFASTINT (num
, depth
);
420 tail
= Fnthcdr (num
, Vminibuffer_list
);
423 tail
= Fcons (Qnil
, Qnil
);
424 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
427 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
429 sprintf (name
, " *Minibuf-%d*", depth
);
430 buf
= Fget_buffer_create (build_string (name
));
432 /* Although the buffer's name starts with a space, undo should be
434 Fbuffer_enable_undo (buf
);
436 XCONS (tail
)->car
= buf
;
440 int count
= specpdl_ptr
- specpdl
;
442 reset_buffer (XBUFFER (buf
));
443 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
445 Fkill_all_local_variables ();
446 unbind_to (count
, Qnil
);
452 /* This function is called on exiting minibuffer, whether normally or not,
453 and it restores the current window, buffer, etc. */
456 read_minibuf_unwind (data
)
459 Lisp_Object old_deactivate_mark
;
462 /* We are exiting the minibuffer one way or the other,
464 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
465 && !NILP (Vrun_hooks
))
466 safe_run_hooks (Qminibuffer_exit_hook
);
468 /* If this was a recursive minibuffer,
469 tie the minibuffer window back to the outer level minibuffer buffer. */
472 window
= minibuf_window
;
473 /* To keep things predictable, in case it matters, let's be in the minibuffer
474 when we reset the relevant variables. */
475 Fset_buffer (XWINDOW (window
)->buffer
);
477 /* Restore prompt, etc, from outer minibuffer level. */
478 minibuf_prompt
= Fcar (minibuf_save_list
);
479 minibuf_save_list
= Fcdr (minibuf_save_list
);
480 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
481 minibuf_save_list
= Fcdr (minibuf_save_list
);
482 Vhelp_form
= Fcar (minibuf_save_list
);
483 minibuf_save_list
= Fcdr (minibuf_save_list
);
484 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
485 minibuf_save_list
= Fcdr (minibuf_save_list
);
486 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
487 minibuf_save_list
= Fcdr (minibuf_save_list
);
488 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
489 minibuf_save_list
= Fcdr (minibuf_save_list
);
490 Voverriding_local_map
= Fcar (minibuf_save_list
);
491 minibuf_save_list
= Fcdr (minibuf_save_list
);
492 minibuf_window
= Fcar (minibuf_save_list
);
493 minibuf_save_list
= Fcdr (minibuf_save_list
);
495 /* Erase the minibuffer we were using at this level. */
497 int count
= specpdl_ptr
- specpdl
;
498 /* Prevent error in erase-buffer. */
499 specbind (Qinhibit_read_only
, Qt
);
500 old_deactivate_mark
= Vdeactivate_mark
;
502 Vdeactivate_mark
= old_deactivate_mark
;
503 unbind_to (count
, Qnil
);
506 /* Make sure minibuffer window is erased, not ignored. */
507 windows_or_buffers_changed
++;
508 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
509 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
513 /* This comment supplies the doc string for read-from-minibuffer,
514 for make-docfile to see. We cannot put this in the real DEFUN
515 due to limits in the Unix cpp.
517 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
518 "Read a string from the minibuffer, prompting with string PROMPT.\n\
519 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
520 to be inserted into the minibuffer before reading input.\n\
521 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
522 is STRING, but point is placed at position POSITION in the minibuffer.\n\
523 Third arg KEYMAP is a keymap to use whilst reading;\n\
524 if omitted or nil, the default is `minibuffer-local-map'.\n\
525 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
526 and return that object:\n\
527 in other words, do `(car (read-from-string INPUT-STRING))'\n\
528 Fifth arg HIST, if non-nil, specifies a history list\n\
529 and optionally the initial position in the list.\n\
530 It can be a symbol, which is the history list variable to use,\n\
531 or it can be a cons cell (HISTVAR . HISTPOS).\n\
532 In that case, HISTVAR is the history list variable to use,\n\
533 and HISTPOS is the initial position (the position in the list\n\
534 which INITIAL-CONTENTS corresponds to).\n\
535 Positions are counted starting from 1 at the beginning of the list."
538 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 5, 0,
539 0 /* See immediately above */)
540 (prompt
, initial_contents
, keymap
, read
, hist
)
541 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
;
544 Lisp_Object histvar
, histpos
, position
;
547 CHECK_STRING (prompt
, 0);
548 if (!NILP (initial_contents
))
550 if (CONSP (initial_contents
))
552 position
= Fcdr (initial_contents
);
553 initial_contents
= Fcar (initial_contents
);
555 CHECK_STRING (initial_contents
, 1);
556 if (!NILP (position
))
558 CHECK_NUMBER (position
, 0);
559 /* Convert to distance from end of input. */
560 if (XINT (position
) < 1)
561 /* A number too small means the beginning of the string. */
562 pos
= - XSTRING (initial_contents
)->size
;
564 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
569 keymap
= Vminibuffer_local_map
;
571 keymap
= get_keymap (keymap
,2);
580 histvar
= Fcar_safe (hist
);
581 histpos
= Fcdr_safe (hist
);
584 histvar
= Qminibuffer_history
;
586 XSETFASTINT (histpos
, 0);
588 return read_minibuf (keymap
, initial_contents
, prompt
,
589 make_number (pos
), !NILP (read
), histvar
, histpos
);
592 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
593 "Return a Lisp object read using the minibuffer.\n\
594 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
595 is a string to insert in the minibuffer before reading.")
596 (prompt
, initial_contents
)
597 Lisp_Object prompt
, initial_contents
;
599 CHECK_STRING (prompt
, 0);
600 if (!NILP (initial_contents
))
601 CHECK_STRING (initial_contents
, 1);
602 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
603 prompt
, Qnil
, 1, Qminibuffer_history
, make_number (0));
606 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
607 "Return value of Lisp expression read using the minibuffer.\n\
608 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
609 is a string to insert in the minibuffer before reading.")
610 (prompt
, initial_contents
)
611 Lisp_Object prompt
, initial_contents
;
613 return Feval (Fread_minibuffer (prompt
, initial_contents
));
616 /* Functions that use the minibuffer to read various things. */
618 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 3, 0,
619 "Read a string from the minibuffer, prompting with string PROMPT.\n\
620 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
621 The third arg HISTORY, if non-nil, specifies a history list\n\
622 and optionally the initial position in the list.\n\
623 See `read-from-minibuffer' for details of HISTORY argument.")
624 (prompt
, initial_input
, history
)
625 Lisp_Object prompt
, initial_input
, history
;
627 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
, Qnil
, history
);
630 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 2, 0,
631 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
632 Prompt with PROMPT, and provide INIT as an initial value of the input string.")
634 Lisp_Object prompt
, init
;
636 CHECK_STRING (prompt
, 0);
638 CHECK_STRING (init
, 1);
640 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
, 0,
641 Qminibuffer_history
, make_number (0));
644 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 1, 0,
645 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
646 Prompts with PROMPT.")
650 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
, Qnil
, Qnil
),
655 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
656 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
657 Prompts with PROMPT.")
661 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
),
666 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 1, 0,
667 "One arg PROMPT, a string. Read the name of a user variable and return\n\
668 it as a symbol. Prompts with PROMPT.\n\
669 A user variable is one whose documentation starts with a `*' character.")
673 return Fintern (Fcompleting_read (prompt
, Vobarray
,
674 Quser_variable_p
, Qt
, Qnil
, Qnil
),
678 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
679 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
680 Prompts with PROMPT.\n\
681 Optional second arg is value to return if user enters an empty line.\n\
682 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
683 (prompt
, def
, require_match
)
684 Lisp_Object prompt
, def
, require_match
;
691 def
= XBUFFER (def
)->name
;
694 args
[0] = build_string ("%s(default %s) ");
697 prompt
= Fformat (3, args
);
700 tem
= Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
, require_match
, Qnil
, Qnil
);
702 if (XSTRING (tem
)->size
)
707 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
708 "Return common substring of all completions of STRING in ALIST.\n\
709 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
710 All that match are compared together; the longest initial sequence\n\
711 common to all matches is returned as a string.\n\
712 If there is no match at all, nil is returned.\n\
713 For an exact match, t is returned.\n\
715 ALIST can be an obarray instead of an alist.\n\
716 Then the print names of all symbols in the obarray are the possible matches.\n\
718 ALIST can also be a function to do the completion itself.\n\
719 It receives three arguments: the values STRING, PREDICATE and nil.\n\
720 Whatever it returns becomes the value of `try-completion'.\n\
722 If optional third argument PREDICATE is non-nil,\n\
723 it is used to test each possible match.\n\
724 The match is a candidate only if PREDICATE returns non-nil.\n\
725 The argument given to PREDICATE is the alist element\n\
726 or the symbol from the obarray.")
727 (string
, alist
, predicate
)
728 Lisp_Object string
, alist
, predicate
;
730 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
732 int compare
, matchsize
;
733 int list
= CONSP (alist
) || NILP (alist
);
736 Lisp_Object bucket
, zero
, end
, tem
;
737 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
739 CHECK_STRING (string
, 0);
740 if (!list
&& !VECTORP (alist
))
741 return call3 (alist
, string
, predicate
, Qnil
);
745 /* If ALIST is not a list, set TAIL just for gc pro. */
750 obsize
= XVECTOR (alist
)->size
;
751 bucket
= XVECTOR (alist
)->contents
[index
];
756 /* Get the next element of the alist or obarray. */
757 /* Exit the loop if the elements are all used up. */
758 /* elt gets the alist element or symbol.
759 eltstring gets the name to check as a completion. */
766 eltstring
= Fcar (elt
);
771 if (XFASTINT (bucket
) != 0)
774 eltstring
= Fsymbol_name (elt
);
775 if (XSYMBOL (bucket
)->next
)
776 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
778 XSETFASTINT (bucket
, 0);
780 else if (++index
>= obsize
)
784 bucket
= XVECTOR (alist
)->contents
[index
];
789 /* Is this element a possible completion? */
791 if (STRINGP (eltstring
)
792 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
793 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
794 XSTRING (string
)->size
))
799 XSETFASTINT (zero
, 0);
801 /* Ignore this element if it fails to match all the regexps. */
802 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
803 regexps
= XCONS (regexps
)->cdr
)
805 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
812 /* Ignore this element if there is a predicate
813 and the predicate doesn't like it. */
815 if (!NILP (predicate
))
817 if (EQ (predicate
, Qcommandp
))
818 tem
= Fcommandp (elt
);
821 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
822 tem
= call1 (predicate
, elt
);
825 if (NILP (tem
)) continue;
828 /* Update computation of how much all possible completions match */
831 if (NILP (bestmatch
))
832 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
835 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
836 matchsize
= scmp (XSTRING (bestmatch
)->data
,
837 XSTRING (eltstring
)->data
,
841 if (completion_ignore_case
)
843 /* If this is an exact match except for case,
844 use it as the best match rather than one that is not an
845 exact match. This way, we get the case pattern
846 of the actual match. */
847 if ((matchsize
== XSTRING (eltstring
)->size
848 && matchsize
< XSTRING (bestmatch
)->size
)
850 /* If there is more than one exact match ignoring case,
851 and one of them is exact including case,
853 /* If there is no exact match ignoring case,
854 prefer a match that does not change the case
856 ((matchsize
== XSTRING (eltstring
)->size
)
858 (matchsize
== XSTRING (bestmatch
)->size
)
859 && !bcmp (XSTRING (eltstring
)->data
,
860 XSTRING (string
)->data
, XSTRING (string
)->size
)
861 && bcmp (XSTRING (bestmatch
)->data
,
862 XSTRING (string
)->data
, XSTRING (string
)->size
)))
863 bestmatch
= eltstring
;
865 bestmatchsize
= matchsize
;
870 if (NILP (bestmatch
))
871 return Qnil
; /* No completions found */
872 /* If we are ignoring case, and there is no exact match,
873 and no additional text was supplied,
874 don't change the case of what the user typed. */
875 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
876 && XSTRING (bestmatch
)->size
> bestmatchsize
)
879 /* Return t if the supplied string is an exact match (counting case);
880 it does not require any change to be made. */
881 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
882 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
886 XSETFASTINT (zero
, 0); /* Else extract the part in which */
887 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
888 return Fsubstring (bestmatch
, zero
, end
);
891 /* Compare exactly LEN chars of strings at S1 and S2,
892 ignoring case if appropriate.
893 Return -1 if strings match,
894 else number of chars that match at the beginning. */
898 register unsigned char *s1
, *s2
;
901 register int l
= len
;
903 if (completion_ignore_case
)
905 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
910 while (l
&& *s1
++ == *s2
++)
919 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
920 "Search for partial matches to STRING in ALIST.\n\
921 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
922 The value is a list of all the strings from ALIST that match.\n\
924 ALIST can be an obarray instead of an alist.\n\
925 Then the print names of all symbols in the obarray are the possible matches.\n\
927 ALIST can also be a function to do the completion itself.\n\
928 It receives three arguments: the values STRING, PREDICATE and t.\n\
929 Whatever it returns becomes the value of `all-completion'.\n\
931 If optional third argument PREDICATE is non-nil,\n\
932 it is used to test each possible match.\n\
933 The match is a candidate only if PREDICATE returns non-nil.\n\
934 The argument given to PREDICATE is the alist element\n\
935 or the symbol from the obarray.\n\
937 If the optional fourth argument HIDE-SPACES is non-nil,\n\
938 strings in ALIST that start with a space\n\
939 are ignored unless STRING itself starts with a space.")
940 (string
, alist
, predicate
, hide_spaces
)
941 Lisp_Object string
, alist
, predicate
, hide_spaces
;
943 Lisp_Object tail
, elt
, eltstring
;
944 Lisp_Object allmatches
;
945 int list
= CONSP (alist
) || NILP (alist
);
947 Lisp_Object bucket
, tem
;
948 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
950 CHECK_STRING (string
, 0);
951 if (!list
&& !VECTORP (alist
))
953 return call3 (alist
, string
, predicate
, Qt
);
957 /* If ALIST is not a list, set TAIL just for gc pro. */
962 obsize
= XVECTOR (alist
)->size
;
963 bucket
= XVECTOR (alist
)->contents
[index
];
968 /* Get the next element of the alist or obarray. */
969 /* Exit the loop if the elements are all used up. */
970 /* elt gets the alist element or symbol.
971 eltstring gets the name to check as a completion. */
978 eltstring
= Fcar (elt
);
983 if (XFASTINT (bucket
) != 0)
986 eltstring
= Fsymbol_name (elt
);
987 if (XSYMBOL (bucket
)->next
)
988 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
990 XSETFASTINT (bucket
, 0);
992 else if (++index
>= obsize
)
996 bucket
= XVECTOR (alist
)->contents
[index
];
1001 /* Is this element a possible completion? */
1003 if (STRINGP (eltstring
)
1004 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1005 /* If HIDE_SPACES, reject alternatives that start with space
1006 unless the input starts with space. */
1007 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
1008 || XSTRING (eltstring
)->data
[0] != ' '
1009 || NILP (hide_spaces
))
1010 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1011 XSTRING (string
)->size
))
1014 Lisp_Object regexps
;
1016 XSETFASTINT (zero
, 0);
1018 /* Ignore this element if it fails to match all the regexps. */
1019 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1020 regexps
= XCONS (regexps
)->cdr
)
1022 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1026 if (CONSP (regexps
))
1029 /* Ignore this element if there is a predicate
1030 and the predicate doesn't like it. */
1032 if (!NILP (predicate
))
1034 if (EQ (predicate
, Qcommandp
))
1035 tem
= Fcommandp (elt
);
1038 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1039 tem
= call1 (predicate
, elt
);
1042 if (NILP (tem
)) continue;
1044 /* Ok => put it on the list. */
1045 allmatches
= Fcons (eltstring
, allmatches
);
1049 return Fnreverse (allmatches
);
1052 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1053 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1054 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1056 /* This comment supplies the doc string for completing-read,
1057 for make-docfile to see. We cannot put this in the real DEFUN
1058 due to limits in the Unix cpp.
1060 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
1061 "Read a string in the minibuffer, with completion.\n\
1062 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1063 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1064 PREDICATE limits completion to a subset of TABLE.\n\
1065 See `try-completion' and `all-completions' for more details
1066 on completion, TABLE, and PREDICATE.\n\
1068 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1069 the input is (or completes to) an element of TABLE or is null.\n\
1070 If it is also not t, Return does not exit if it does non-null completion.\n\
1071 If the input is null, `completing-read' returns an empty string,\n\
1072 regardless of the value of REQUIRE-MATCH.\n\
1074 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1075 If it is (STRING . POSITION), the initial input\n\
1076 is STRING, but point is placed POSITION characters into the string.\n\
1077 HIST, if non-nil, specifies a history list\n\
1078 and optionally the initial position in the list.\n\
1079 It can be a symbol, which is the history list variable to use,\n\
1080 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1081 In that case, HISTVAR is the history list variable to use,\n\
1082 and HISTPOS is the initial position (the position in the list\n\
1083 which INITIAL-CONTENTS corresponds to).\n\
1084 Positions are counted starting from 1 at the beginning of the list.\n\
1085 Completion ignores case if the ambient value of\n\
1086 `completion-ignore-case' is non-nil."
1088 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 6, 0,
1089 0 /* See immediately above */)
1090 (prompt
, table
, predicate
, require_match
, init
, hist
)
1091 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
;
1093 Lisp_Object val
, histvar
, histpos
, position
;
1095 int count
= specpdl_ptr
- specpdl
;
1096 specbind (Qminibuffer_completion_table
, table
);
1097 specbind (Qminibuffer_completion_predicate
, predicate
);
1098 specbind (Qminibuffer_completion_confirm
,
1099 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1100 last_exact_completion
= Qnil
;
1107 position
= Fcdr (init
);
1110 CHECK_STRING (init
, 0);
1111 if (!NILP (position
))
1113 CHECK_NUMBER (position
, 0);
1114 /* Convert to distance from end of input. */
1115 pos
= XINT (position
) - XSTRING (init
)->size
;
1126 histvar
= Fcar_safe (hist
);
1127 histpos
= Fcdr_safe (hist
);
1130 histvar
= Qminibuffer_history
;
1132 XSETFASTINT (histpos
, 0);
1134 val
= read_minibuf (NILP (require_match
)
1135 ? Vminibuffer_local_completion_map
1136 : Vminibuffer_local_must_match_map
,
1137 init
, prompt
, make_number (pos
), 0,
1139 return unbind_to (count
, val
);
1142 /* Temporarily display the string M at the end of the current
1143 minibuffer contents. This is used to display things like
1144 "[No Match]" when the user requests a completion for a prefix
1145 that has no possible completions, and other quick, unobtrusive
1148 temp_echo_area_glyphs (m
)
1153 Lisp_Object oinhibit
;
1154 oinhibit
= Vinhibit_quit
;
1156 /* Clear out any old echo-area message to make way for our new thing. */
1163 Fsit_for (make_number (2), Qnil
, Qnil
);
1164 del_range (osize
, ZV
);
1166 if (!NILP (Vquit_flag
))
1169 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1171 Vinhibit_quit
= oinhibit
;
1174 Lisp_Object
Fminibuffer_completion_help ();
1175 Lisp_Object
assoc_for_completion ();
1176 /* A subroutine of Fintern_soft. */
1177 extern Lisp_Object
oblookup ();
1180 /* Test whether TXT is an exact completion. */
1182 test_completion (txt
)
1187 if (CONSP (Vminibuffer_completion_table
)
1188 || NILP (Vminibuffer_completion_table
))
1189 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1190 else if (VECTORP (Vminibuffer_completion_table
))
1192 /* Bypass intern-soft as that loses for nil */
1193 tem
= oblookup (Vminibuffer_completion_table
,
1194 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1197 else if (!NILP (Vminibuffer_completion_predicate
))
1198 return call1 (Vminibuffer_completion_predicate
, tem
);
1203 return call3 (Vminibuffer_completion_table
, txt
,
1204 Vminibuffer_completion_predicate
, Qlambda
);
1208 * 0 no possible completion
1209 * 1 was already an exact and unique completion
1210 * 3 was already an exact completion
1211 * 4 completed to an exact completion
1212 * 5 some completion happened
1213 * 6 no completion happened
1218 Lisp_Object completion
, tem
;
1221 struct gcpro gcpro1
, gcpro2
;
1223 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1224 Vminibuffer_completion_predicate
);
1225 last
= last_exact_completion
;
1226 last_exact_completion
= Qnil
;
1228 GCPRO2 (completion
, last
);
1230 if (NILP (completion
))
1233 temp_echo_area_glyphs (" [No match]");
1238 if (EQ (completion
, Qt
)) /* exact and unique match */
1245 tem
= Fstring_equal (completion
, Fbuffer_string());
1246 if (completedp
= NILP (tem
))
1248 Ferase_buffer (); /* Some completion happened */
1249 Finsert (1, &completion
);
1252 /* It did find a match. Do we match some possibility exactly now? */
1253 tem
= test_completion (Fbuffer_string ());
1256 /* not an exact match */
1261 Fminibuffer_completion_help ();
1263 temp_echo_area_glyphs (" [Next char not unique]");
1266 else if (completedp
)
1271 /* If the last exact completion and this one were the same,
1272 it means we've already given a "Complete but not unique"
1273 message and the user's hit TAB again, so now we give him help. */
1274 last_exact_completion
= completion
;
1277 tem
= Fbuffer_string ();
1278 if (!NILP (Fequal (tem
, last
)))
1279 Fminibuffer_completion_help ();
1285 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1288 assoc_for_completion (key
, list
)
1289 register Lisp_Object key
;
1292 register Lisp_Object tail
;
1294 if (completion_ignore_case
)
1295 key
= Fupcase (key
);
1297 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1299 register Lisp_Object elt
, tem
, thiscar
;
1301 if (!CONSP (elt
)) continue;
1302 thiscar
= Fcar (elt
);
1303 if (!STRINGP (thiscar
))
1305 if (completion_ignore_case
)
1306 thiscar
= Fupcase (thiscar
);
1307 tem
= Fequal (thiscar
, key
);
1308 if (!NILP (tem
)) return elt
;
1314 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1315 "Complete the minibuffer contents as far as possible.\n\
1316 Return nil if there is no valid completion, else t.\n\
1317 If no characters can be completed, display a list of possible completions.\n\
1318 If you repeat this command after it displayed such a list,\n\
1319 scroll the window of possible completions.")
1323 Lisp_Object window
, tem
;
1325 /* If the previous command was not this, then mark the completion
1327 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1328 Vminibuf_scroll_window
= Qnil
;
1330 window
= Vminibuf_scroll_window
;
1331 /* If there's a fresh completion window with a live buffer,
1332 and this command is repeated, scroll that window. */
1333 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1334 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1336 struct buffer
*obuf
= current_buffer
;
1338 Fset_buffer (XWINDOW (window
)->buffer
);
1339 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1341 /* If end is in view, scroll up to the beginning. */
1342 Fset_window_start (window
, BEGV
, Qnil
);
1344 /* Else scroll down one screen. */
1345 Fscroll_other_window (Qnil
);
1347 set_buffer_internal (obuf
);
1351 i
= do_completion ();
1358 temp_echo_area_glyphs (" [Sole completion]");
1362 temp_echo_area_glyphs (" [Complete, but not unique]");
1369 /* Subroutines of Fminibuffer_complete_and_exit. */
1371 /* This one is called by internal_condition_case to do the real work. */
1374 complete_and_exit_1 ()
1376 return make_number (do_completion ());
1379 /* This one is called by internal_condition_case if an error happens.
1380 Pretend the current value is an exact match. */
1383 complete_and_exit_2 (ignore
)
1386 return make_number (1);
1389 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1390 Sminibuffer_complete_and_exit
, 0, 0, "",
1391 "If the minibuffer contents is a valid completion then exit.\n\
1392 Otherwise try to complete it. If completion leads to a valid completion,\n\
1393 a repetition of this command will exit.")
1399 /* Allow user to specify null string */
1403 if (!NILP (test_completion (Fbuffer_string ())))
1406 /* Call do_completion, but ignore errors. */
1407 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1408 complete_and_exit_2
);
1418 if (!NILP (Vminibuffer_completion_confirm
))
1420 temp_echo_area_glyphs (" [Confirm]");
1430 Fthrow (Qexit
, Qnil
);
1434 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1436 "Complete the minibuffer contents at most a single word.\n\
1437 After one word is completed as much as possible, a space or hyphen\n\
1438 is added, provided that matches some possible completion.\n\
1439 Return nil if there is no valid completion, else t.")
1442 Lisp_Object completion
, tem
;
1444 register unsigned char *completion_string
;
1445 struct gcpro gcpro1
, gcpro2
;
1447 /* We keep calling Fbuffer_string rather than arrange for GC to
1448 hold onto a pointer to one of the strings thus made. */
1450 completion
= Ftry_completion (Fbuffer_string (),
1451 Vminibuffer_completion_table
,
1452 Vminibuffer_completion_predicate
);
1453 if (NILP (completion
))
1456 temp_echo_area_glyphs (" [No match]");
1459 if (EQ (completion
, Qt
))
1462 #if 0 /* How the below code used to look, for reference. */
1463 tem
= Fbuffer_string ();
1464 b
= XSTRING (tem
)->data
;
1465 i
= ZV
- 1 - XSTRING (completion
)->size
;
1466 p
= XSTRING (completion
)->data
;
1468 0 <= scmp (b
, p
, ZV
- 1))
1471 /* Set buffer to longest match of buffer tail and completion head. */
1472 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1474 del_range (1, i
+ 1);
1477 #else /* Rewritten code */
1479 register unsigned char *buffer_string
;
1480 int buffer_length
, completion_length
;
1482 CHECK_STRING (completion
, 0);
1483 tem
= Fbuffer_string ();
1484 GCPRO2 (completion
, tem
);
1485 /* If reading a file name,
1486 expand any $ENVVAR refs in the buffer and in TEM. */
1487 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1489 Lisp_Object substituted
;
1490 substituted
= Fsubstitute_in_file_name (tem
);
1491 if (! EQ (substituted
, tem
))
1495 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1498 buffer_string
= XSTRING (tem
)->data
;
1499 completion_string
= XSTRING (completion
)->data
;
1500 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1501 completion_length
= XSTRING (completion
)->size
;
1502 i
= buffer_length
- completion_length
;
1503 /* Mly: I don't understand what this is supposed to do AT ALL */
1505 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1507 /* Set buffer to longest match of buffer tail and completion head. */
1511 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1513 del_range (1, i
+ 1);
1518 #endif /* Rewritten code */
1521 /* If completion finds next char not unique,
1522 consider adding a space or a hyphen. */
1523 if (i
== XSTRING (completion
)->size
)
1525 GCPRO1 (completion
);
1526 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1527 Vminibuffer_completion_table
,
1528 Vminibuffer_completion_predicate
);
1535 GCPRO1 (completion
);
1537 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1538 Vminibuffer_completion_table
,
1539 Vminibuffer_completion_predicate
);
1547 /* Now find first word-break in the stuff found by completion.
1548 i gets index in string of where to stop completing. */
1550 completion_string
= XSTRING (completion
)->data
;
1552 for (; i
< XSTRING (completion
)->size
; i
++)
1553 if (SYNTAX (completion_string
[i
]) != Sword
) break;
1554 if (i
< XSTRING (completion
)->size
)
1557 /* If got no characters, print help for user. */
1562 Fminibuffer_completion_help ();
1566 /* Otherwise insert in minibuffer the chars we got */
1569 insert_from_string (completion
, 0, i
, 1);
1573 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1575 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1576 Each element may be just a symbol or string\n\
1577 or may be a list of two strings to be printed as if concatenated.\n\
1578 `standard-output' must be a buffer.\n\
1579 At the end, run the normal hook `completion-setup-hook'.\n\
1580 It can find the completion buffer in `standard-output'.")
1582 Lisp_Object completions
;
1584 Lisp_Object tail
, elt
;
1587 struct gcpro gcpro1
, gcpro2
;
1588 struct buffer
*old
= current_buffer
;
1591 /* Note that (when it matters) every variable
1592 points to a non-string that is pointed to by COMPLETIONS,
1593 except for ELT. ELT can be pointing to a string
1594 when terpri or Findent_to calls a change hook. */
1596 GCPRO2 (completions
, elt
);
1598 if (BUFFERP (Vstandard_output
))
1599 set_buffer_internal (XBUFFER (Vstandard_output
));
1601 if (NILP (completions
))
1602 write_string ("There are no possible completions of what you have typed.",
1606 write_string ("Possible completions are:", -1);
1607 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1611 Lisp_Object startpos
, endpos
;
1614 /* Compute the length of this element. */
1618 CHECK_STRING (tem
, 0);
1619 length
= XINT (XSTRING (tem
)->size
);
1621 tem
= Fcar (Fcdr (elt
));
1622 CHECK_STRING (tem
, 0);
1623 length
+= XINT (XSTRING (tem
)->size
);
1627 CHECK_STRING (elt
, 0);
1628 length
= XINT (XSTRING (elt
)->size
);
1631 /* This does a bad job for narrower than usual windows.
1632 Sadly, the window it will appear in is not known
1633 until after the text has been made. */
1635 if (BUFFERP (Vstandard_output
))
1636 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1638 /* If the previous completion was very wide,
1639 or we have two on this line already,
1640 don't put another on the same line. */
1641 if (column
> 33 || first
1642 /* If this is really wide, don't put it second on a line. */
1643 || column
> 0 && length
> 45)
1648 /* Otherwise advance to column 35. */
1651 if (BUFFERP (Vstandard_output
))
1653 tem
= Findent_to (make_number (35), make_number (2));
1655 column
= XINT (tem
);
1661 write_string (" ", -1);
1664 while (column
< 35);
1668 if (BUFFERP (Vstandard_output
))
1670 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1671 Fset_text_properties (startpos
, endpos
,
1672 Qnil
, Vstandard_output
);
1675 /* Output this element and update COLUMN. */
1678 Fprinc (Fcar (elt
), Qnil
);
1679 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1686 /* If output is to a buffer, recompute COLUMN in a way
1687 that takes account of character widths. */
1688 if (BUFFERP (Vstandard_output
))
1690 tem
= Fcurrent_column ();
1691 column
= XINT (tem
);
1700 if (BUFFERP (Vstandard_output
))
1701 set_buffer_internal (old
);
1703 if (!NILP (Vrun_hooks
))
1704 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1709 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1711 "Display a list of possible completions of the current minibuffer contents.")
1714 Lisp_Object completions
;
1716 message ("Making completion list...");
1717 completions
= Fall_completions (Fbuffer_string (),
1718 Vminibuffer_completion_table
,
1719 Vminibuffer_completion_predicate
,
1721 echo_area_glyphs
= 0;
1723 if (NILP (completions
))
1726 temp_echo_area_glyphs (" [No completions]");
1729 internal_with_output_to_temp_buffer ("*Completions*",
1730 Fdisplay_completion_list
,
1731 Fsort (completions
, Qstring_lessp
));
1735 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1736 "Terminate minibuffer input.")
1739 if (INTEGERP (last_command_char
))
1740 internal_self_insert (last_command_char
, 0);
1744 Fthrow (Qexit
, Qnil
);
1747 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1748 "Terminate this minibuffer argument.")
1751 Fthrow (Qexit
, Qnil
);
1754 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1755 "Return current depth of activations of minibuffer, a nonnegative integer.")
1758 return make_number (minibuf_level
);
1761 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1762 "Return the prompt string of the currently-active minibuffer.\n\
1763 If no minibuffer is active, return nil.")
1766 return Fcopy_sequence (minibuf_prompt
);
1769 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1770 Sminibuffer_prompt_width
, 0, 0, 0,
1771 "Return the display width of the minibuffer prompt.")
1775 XSETFASTINT (width
, minibuf_prompt_width
);
1779 init_minibuf_once ()
1781 Vminibuffer_list
= Qnil
;
1782 staticpro (&Vminibuffer_list
);
1788 minibuf_prompt
= Qnil
;
1789 staticpro (&minibuf_prompt
);
1791 minibuf_save_list
= Qnil
;
1792 staticpro (&minibuf_save_list
);
1794 Qread_file_name_internal
= intern ("read-file-name-internal");
1795 staticpro (&Qread_file_name_internal
);
1797 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1798 staticpro (&Qminibuffer_completion_table
);
1800 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1801 staticpro (&Qminibuffer_completion_confirm
);
1803 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1804 staticpro (&Qminibuffer_completion_predicate
);
1806 staticpro (&last_exact_completion
);
1807 last_exact_completion
= Qnil
;
1809 staticpro (&last_minibuf_string
);
1810 last_minibuf_string
= Qnil
;
1812 Quser_variable_p
= intern ("user-variable-p");
1813 staticpro (&Quser_variable_p
);
1815 Qminibuffer_history
= intern ("minibuffer-history");
1816 staticpro (&Qminibuffer_history
);
1818 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1819 staticpro (&Qminibuffer_setup_hook
);
1821 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1822 staticpro (&Qminibuffer_exit_hook
);
1824 Qhistory_length
= intern ("history-length");
1825 staticpro (&Qhistory_length
);
1827 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1828 "Normal hook run just after entry to minibuffer.");
1829 Vminibuffer_setup_hook
= Qnil
;
1831 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1832 "Normal hook run just after exit from minibuffer.");
1833 Vminibuffer_exit_hook
= Qnil
;
1835 DEFVAR_LISP ("history-length", &Vhistory_length
,
1836 "*Maximum length for history lists before truncation takes place.\n\
1837 A number means that length; t means infinite. Truncation takes place\n\
1838 just after a new element is inserted. Setting the history-length\n\
1839 property of a history variable overrides this default.");
1840 XSETFASTINT (Vhistory_length
, 30);
1842 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1843 "*Non-nil means automatically provide help for invalid completion input.");
1846 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
1847 "Non-nil means don't consider case significant in completion.");
1848 completion_ignore_case
= 0;
1850 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
1851 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1852 More precisely, this variable makes a difference when the minibuffer window\n\
1853 is the selected window. If you are in some other window, minibuffer commands\n\
1854 are allowed even if a minibuffer is active.");
1855 enable_recursive_minibuffers
= 0;
1857 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
1858 "Alist or obarray used for completion in the minibuffer.\n\
1859 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1861 The value may alternatively be a function, which is given three arguments:\n\
1862 STRING, the current buffer contents;\n\
1863 PREDICATE, the predicate for filtering possible matches;\n\
1864 CODE, which says what kind of things to do.\n\
1865 CODE can be nil, t or `lambda'.\n\
1866 nil means to return the best completion of STRING, or nil if there is none.\n\
1867 t means to return a list of all possible completions of STRING.\n\
1868 `lambda' means to return t if STRING is a valid completion as it stands.");
1869 Vminibuffer_completion_table
= Qnil
;
1871 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
1872 "Within call to `completing-read', this holds the PREDICATE argument.");
1873 Vminibuffer_completion_predicate
= Qnil
;
1875 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
1876 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1877 Vminibuffer_completion_confirm
= Qnil
;
1879 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
1880 "Value that `help-form' takes on inside the minibuffer.");
1881 Vminibuffer_help_form
= Qnil
;
1883 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
1884 "History list symbol to add minibuffer values to.\n\
1885 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
1887 (set minibuffer-history-variable\n\
1888 (cons STRING (symbol-value minibuffer-history-variable)))");
1889 XSETFASTINT (Vminibuffer_history_variable
, 0);
1891 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
1892 "Current position of redoing in the history list.");
1893 Vminibuffer_history_position
= Qnil
;
1895 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
1896 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1897 minibuffer_auto_raise
= 0;
1899 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
1900 "List of regexps that should restrict possible completions.");
1901 Vcompletion_regexp_list
= Qnil
;
1903 defsubr (&Sset_minibuffer_window
);
1904 defsubr (&Sread_from_minibuffer
);
1905 defsubr (&Seval_minibuffer
);
1906 defsubr (&Sread_minibuffer
);
1907 defsubr (&Sread_string
);
1908 defsubr (&Sread_command
);
1909 defsubr (&Sread_variable
);
1910 defsubr (&Sread_buffer
);
1911 defsubr (&Sread_no_blanks_input
);
1912 defsubr (&Sminibuffer_depth
);
1913 defsubr (&Sminibuffer_prompt
);
1914 defsubr (&Sminibuffer_prompt_width
);
1916 defsubr (&Stry_completion
);
1917 defsubr (&Sall_completions
);
1918 defsubr (&Scompleting_read
);
1919 defsubr (&Sminibuffer_complete
);
1920 defsubr (&Sminibuffer_complete_word
);
1921 defsubr (&Sminibuffer_complete_and_exit
);
1922 defsubr (&Sdisplay_completion_list
);
1923 defsubr (&Sminibuffer_completion_help
);
1925 defsubr (&Sself_insert_and_exit
);
1926 defsubr (&Sexit_minibuffer
);
1932 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
1933 "abort-recursive-edit");
1934 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
1936 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
1939 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
1940 "abort-recursive-edit");
1941 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
1943 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
1946 initial_define_key (Vminibuffer_local_ns_map
, ' ',
1948 initial_define_key (Vminibuffer_local_ns_map
, '\t',
1950 initial_define_key (Vminibuffer_local_ns_map
, '?',
1951 "self-insert-and-exit");
1953 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
1954 "abort-recursive-edit");
1955 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
1957 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
1960 initial_define_key (Vminibuffer_local_completion_map
, '\t',
1961 "minibuffer-complete");
1962 initial_define_key (Vminibuffer_local_completion_map
, ' ',
1963 "minibuffer-complete-word");
1964 initial_define_key (Vminibuffer_local_completion_map
, '?',
1965 "minibuffer-completion-help");
1967 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
1968 "abort-recursive-edit");
1969 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
1970 "minibuffer-complete-and-exit");
1971 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
1972 "minibuffer-complete-and-exit");
1973 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
1974 "minibuffer-complete");
1975 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
1976 "minibuffer-complete-word");
1977 initial_define_key (Vminibuffer_local_must_match_map
, '?',
1978 "minibuffer-completion-help");