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
) = 0;
337 update_frame (selected_frame
, 1, 1);
340 /* Make minibuffer contents into a string */
341 val
= make_buffer_string (1, Z
, 1);
342 #if 0 /* make_buffer_string should handle the gap. */
343 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
346 /* VAL is the string of minibuffer text. */
347 last_minibuf_string
= val
;
349 /* Add the value to the appropriate history list unless it is empty. */
350 if (XSTRING (val
)->size
!= 0
351 && SYMBOLP (Vminibuffer_history_variable
)
352 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
354 /* If the caller wanted to save the value read on a history list,
355 then do so if the value is not already the front of the list. */
357 histval
= Fsymbol_value (Vminibuffer_history_variable
);
359 /* The value of the history variable must be a cons or nil. Other
360 values are unacceptable. We silently ignore these values. */
363 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
367 histval
= Fcons (last_minibuf_string
, histval
);
368 Fset (Vminibuffer_history_variable
, histval
);
370 /* Truncate if requested. */
371 length
= Fget (Vminibuffer_history_variable
, Qhistory_length
);
372 if (NILP (length
)) length
= Vhistory_length
;
373 if (INTEGERP (length
)) {
374 if (XINT (length
) <= 0)
375 Fset (Vminibuffer_history_variable
, Qnil
);
380 temp
= Fnthcdr (Fsub1 (length
), histval
);
381 if (CONSP (temp
)) Fsetcdr (temp
, Qnil
);
387 /* If Lisp form desired instead of string, parse it. */
390 Lisp_Object expr_and_pos
;
393 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
394 /* Ignore trailing whitespace; any other trailing junk is an error. */
395 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
396 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
397 error ("Trailing garbage following expression");
398 val
= Fcar (expr_and_pos
);
401 /* The appropriate frame will get selected
402 in set-window-configuration. */
403 RETURN_UNGCPRO (unbind_to (count
, val
));
406 /* Return a buffer to be used as the minibuffer at depth `depth'.
407 depth = 0 is the lowest allowed argument, and that is the value
408 used for nonrecursive minibuffer invocations */
411 get_minibuffer (depth
)
414 Lisp_Object tail
, num
, buf
;
416 extern Lisp_Object
nconc2 ();
418 XSETFASTINT (num
, depth
);
419 tail
= Fnthcdr (num
, Vminibuffer_list
);
422 tail
= Fcons (Qnil
, Qnil
);
423 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
426 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
428 sprintf (name
, " *Minibuf-%d*", depth
);
429 buf
= Fget_buffer_create (build_string (name
));
431 /* Although the buffer's name starts with a space, undo should be
433 Fbuffer_enable_undo (buf
);
435 XCONS (tail
)->car
= buf
;
439 int count
= specpdl_ptr
- specpdl
;
441 reset_buffer (XBUFFER (buf
));
442 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
444 Fkill_all_local_variables ();
445 unbind_to (count
, Qnil
);
451 /* This function is called on exiting minibuffer, whether normally or not,
452 and it restores the current window, buffer, etc. */
455 read_minibuf_unwind (data
)
458 Lisp_Object old_deactivate_mark
;
461 /* We are exiting the minibuffer one way or the other,
463 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
464 && !NILP (Vrun_hooks
))
465 safe_run_hooks (Qminibuffer_exit_hook
);
467 /* If this was a recursive minibuffer,
468 tie the minibuffer window back to the outer level minibuffer buffer. */
471 window
= minibuf_window
;
472 /* To keep things predictable, in case it matters, let's be in the minibuffer
473 when we reset the relevant variables. */
474 Fset_buffer (XWINDOW (window
)->buffer
);
476 /* Restore prompt, etc, from outer minibuffer level. */
477 minibuf_prompt
= Fcar (minibuf_save_list
);
478 minibuf_save_list
= Fcdr (minibuf_save_list
);
479 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
480 minibuf_save_list
= Fcdr (minibuf_save_list
);
481 Vhelp_form
= Fcar (minibuf_save_list
);
482 minibuf_save_list
= Fcdr (minibuf_save_list
);
483 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
484 minibuf_save_list
= Fcdr (minibuf_save_list
);
485 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
486 minibuf_save_list
= Fcdr (minibuf_save_list
);
487 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
488 minibuf_save_list
= Fcdr (minibuf_save_list
);
489 Voverriding_local_map
= Fcar (minibuf_save_list
);
490 minibuf_save_list
= Fcdr (minibuf_save_list
);
491 minibuf_window
= Fcar (minibuf_save_list
);
492 minibuf_save_list
= Fcdr (minibuf_save_list
);
494 /* Erase the minibuffer we were using at this level. */
496 int count
= specpdl_ptr
- specpdl
;
497 /* Prevent error in erase-buffer. */
498 specbind (Qinhibit_read_only
, Qt
);
499 old_deactivate_mark
= Vdeactivate_mark
;
501 Vdeactivate_mark
= old_deactivate_mark
;
502 unbind_to (count
, Qnil
);
505 /* Make sure minibuffer window is erased, not ignored. */
506 windows_or_buffers_changed
++;
507 XSETFASTINT (XWINDOW (window
)->last_modified
, 0);
508 XSETFASTINT (XWINDOW (window
)->last_overlay_modified
, 0);
512 /* This comment supplies the doc string for read-from-minibuffer,
513 for make-docfile to see. We cannot put this in the real DEFUN
514 due to limits in the Unix cpp.
516 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
517 "Read a string from the minibuffer, prompting with string PROMPT.\n\
518 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
519 to be inserted into the minibuffer before reading input.\n\
520 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
521 is STRING, but point is placed at position POSITION in the minibuffer.\n\
522 Third arg KEYMAP is a keymap to use whilst reading;\n\
523 if omitted or nil, the default is `minibuffer-local-map'.\n\
524 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
525 and return that object:\n\
526 in other words, do `(car (read-from-string INPUT-STRING))'\n\
527 Fifth arg HIST, if non-nil, specifies a history list\n\
528 and optionally the initial position in the list.\n\
529 It can be a symbol, which is the history list variable to use,\n\
530 or it can be a cons cell (HISTVAR . HISTPOS).\n\
531 In that case, HISTVAR is the history list variable to use,\n\
532 and HISTPOS is the initial position (the position in the list\n\
533 which INITIAL-CONTENTS corresponds to).\n\
534 Positions are counted starting from 1 at the beginning of the list."
537 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 5, 0,
538 0 /* See immediately above */)
539 (prompt
, initial_contents
, keymap
, read
, hist
)
540 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
;
543 Lisp_Object histvar
, histpos
, position
;
546 CHECK_STRING (prompt
, 0);
547 if (!NILP (initial_contents
))
549 if (CONSP (initial_contents
))
551 position
= Fcdr (initial_contents
);
552 initial_contents
= Fcar (initial_contents
);
554 CHECK_STRING (initial_contents
, 1);
555 if (!NILP (position
))
557 CHECK_NUMBER (position
, 0);
558 /* Convert to distance from end of input. */
559 if (XINT (position
) < 1)
560 /* A number too small means the beginning of the string. */
561 pos
= - XSTRING (initial_contents
)->size
;
563 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
568 keymap
= Vminibuffer_local_map
;
570 keymap
= get_keymap (keymap
,2);
579 histvar
= Fcar_safe (hist
);
580 histpos
= Fcdr_safe (hist
);
583 histvar
= Qminibuffer_history
;
585 XSETFASTINT (histpos
, 0);
587 return read_minibuf (keymap
, initial_contents
, prompt
,
588 make_number (pos
), !NILP (read
), histvar
, histpos
);
591 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
592 "Return a Lisp object read using the minibuffer.\n\
593 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
594 is a string to insert in the minibuffer before reading.")
595 (prompt
, initial_contents
)
596 Lisp_Object prompt
, initial_contents
;
598 CHECK_STRING (prompt
, 0);
599 if (!NILP (initial_contents
))
600 CHECK_STRING (initial_contents
, 1);
601 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
602 prompt
, Qnil
, 1, Qminibuffer_history
, make_number (0));
605 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
606 "Return value of Lisp expression read using the minibuffer.\n\
607 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
608 is a string to insert in the minibuffer before reading.")
609 (prompt
, initial_contents
)
610 Lisp_Object prompt
, initial_contents
;
612 return Feval (Fread_minibuffer (prompt
, initial_contents
));
615 /* Functions that use the minibuffer to read various things. */
617 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 3, 0,
618 "Read a string from the minibuffer, prompting with string PROMPT.\n\
619 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
620 The third arg HISTORY, if non-nil, specifies a history list\n\
621 and optionally the initial position in the list.\n\
622 See `read-from-minibuffer' for details of HISTORY argument.")
623 (prompt
, initial_input
, history
)
624 Lisp_Object prompt
, initial_input
, history
;
626 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
, Qnil
, history
);
629 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 2, 0,
630 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
631 Prompt with PROMPT, and provide INIT as an initial value of the input string.")
633 Lisp_Object prompt
, init
;
635 CHECK_STRING (prompt
, 0);
637 CHECK_STRING (init
, 1);
639 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
, 0,
640 Qminibuffer_history
, make_number (0));
643 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 1, 0,
644 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
645 Prompts with PROMPT.")
649 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
, Qnil
, Qnil
),
654 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
655 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
656 Prompts with PROMPT.")
660 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
),
665 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 1, 0,
666 "One arg PROMPT, a string. Read the name of a user variable and return\n\
667 it as a symbol. Prompts with PROMPT.\n\
668 A user variable is one whose documentation starts with a `*' character.")
672 return Fintern (Fcompleting_read (prompt
, Vobarray
,
673 Quser_variable_p
, Qt
, Qnil
, Qnil
),
677 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
678 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
679 Prompts with PROMPT.\n\
680 Optional second arg is value to return if user enters an empty line.\n\
681 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
682 (prompt
, def
, require_match
)
683 Lisp_Object prompt
, def
, require_match
;
690 def
= XBUFFER (def
)->name
;
693 args
[0] = build_string ("%s(default %s) ");
696 prompt
= Fformat (3, args
);
699 tem
= Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
, require_match
, Qnil
, Qnil
);
701 if (XSTRING (tem
)->size
)
706 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
707 "Return common substring of all completions of STRING in ALIST.\n\
708 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
709 All that match are compared together; the longest initial sequence\n\
710 common to all matches is returned as a string.\n\
711 If there is no match at all, nil is returned.\n\
712 For an exact match, t is returned.\n\
714 ALIST can be an obarray instead of an alist.\n\
715 Then the print names of all symbols in the obarray are the possible matches.\n\
717 ALIST can also be a function to do the completion itself.\n\
718 It receives three arguments: the values STRING, PREDICATE and nil.\n\
719 Whatever it returns becomes the value of `try-completion'.\n\
721 If optional third argument PREDICATE is non-nil,\n\
722 it is used to test each possible match.\n\
723 The match is a candidate only if PREDICATE returns non-nil.\n\
724 The argument given to PREDICATE is the alist element\n\
725 or the symbol from the obarray.")
726 (string
, alist
, predicate
)
727 Lisp_Object string
, alist
, predicate
;
729 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
731 int compare
, matchsize
;
732 int list
= CONSP (alist
) || NILP (alist
);
735 Lisp_Object bucket
, zero
, end
, tem
;
736 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
738 CHECK_STRING (string
, 0);
739 if (!list
&& !VECTORP (alist
))
740 return call3 (alist
, string
, predicate
, Qnil
);
744 /* If ALIST is not a list, set TAIL just for gc pro. */
749 obsize
= XVECTOR (alist
)->size
;
750 bucket
= XVECTOR (alist
)->contents
[index
];
755 /* Get the next element of the alist or obarray. */
756 /* Exit the loop if the elements are all used up. */
757 /* elt gets the alist element or symbol.
758 eltstring gets the name to check as a completion. */
765 eltstring
= Fcar (elt
);
770 if (XFASTINT (bucket
) != 0)
773 eltstring
= Fsymbol_name (elt
);
774 if (XSYMBOL (bucket
)->next
)
775 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
777 XSETFASTINT (bucket
, 0);
779 else if (++index
>= obsize
)
783 bucket
= XVECTOR (alist
)->contents
[index
];
788 /* Is this element a possible completion? */
790 if (STRINGP (eltstring
)
791 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
792 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
793 XSTRING (string
)->size
))
798 XSETFASTINT (zero
, 0);
800 /* Ignore this element if it fails to match all the regexps. */
801 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
802 regexps
= XCONS (regexps
)->cdr
)
804 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
811 /* Ignore this element if there is a predicate
812 and the predicate doesn't like it. */
814 if (!NILP (predicate
))
816 if (EQ (predicate
, Qcommandp
))
817 tem
= Fcommandp (elt
);
820 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
821 tem
= call1 (predicate
, elt
);
824 if (NILP (tem
)) continue;
827 /* Update computation of how much all possible completions match */
830 if (NILP (bestmatch
))
831 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
834 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
835 matchsize
= scmp (XSTRING (bestmatch
)->data
,
836 XSTRING (eltstring
)->data
,
840 if (completion_ignore_case
)
842 /* If this is an exact match except for case,
843 use it as the best match rather than one that is not an
844 exact match. This way, we get the case pattern
845 of the actual match. */
846 if ((matchsize
== XSTRING (eltstring
)->size
847 && matchsize
< XSTRING (bestmatch
)->size
)
849 /* If there is more than one exact match ignoring case,
850 and one of them is exact including case,
852 /* If there is no exact match ignoring case,
853 prefer a match that does not change the case
855 ((matchsize
== XSTRING (eltstring
)->size
)
857 (matchsize
== XSTRING (bestmatch
)->size
)
858 && !bcmp (XSTRING (eltstring
)->data
,
859 XSTRING (string
)->data
, XSTRING (string
)->size
)
860 && bcmp (XSTRING (bestmatch
)->data
,
861 XSTRING (string
)->data
, XSTRING (string
)->size
)))
862 bestmatch
= eltstring
;
864 bestmatchsize
= matchsize
;
869 if (NILP (bestmatch
))
870 return Qnil
; /* No completions found */
871 /* If we are ignoring case, and there is no exact match,
872 and no additional text was supplied,
873 don't change the case of what the user typed. */
874 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
875 && XSTRING (bestmatch
)->size
> bestmatchsize
)
878 /* Return t if the supplied string is an exact match (counting case);
879 it does not require any change to be made. */
880 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
881 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
885 XSETFASTINT (zero
, 0); /* Else extract the part in which */
886 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
887 return Fsubstring (bestmatch
, zero
, end
);
890 /* Compare exactly LEN chars of strings at S1 and S2,
891 ignoring case if appropriate.
892 Return -1 if strings match,
893 else number of chars that match at the beginning. */
897 register unsigned char *s1
, *s2
;
900 register int l
= len
;
902 if (completion_ignore_case
)
904 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
909 while (l
&& *s1
++ == *s2
++)
918 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
919 "Search for partial matches to STRING in ALIST.\n\
920 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
921 The value is a list of all the strings from ALIST that match.\n\
923 ALIST can be an obarray instead of an alist.\n\
924 Then the print names of all symbols in the obarray are the possible matches.\n\
926 ALIST can also be a function to do the completion itself.\n\
927 It receives three arguments: the values STRING, PREDICATE and t.\n\
928 Whatever it returns becomes the value of `all-completion'.\n\
930 If optional third argument PREDICATE is non-nil,\n\
931 it is used to test each possible match.\n\
932 The match is a candidate only if PREDICATE returns non-nil.\n\
933 The argument given to PREDICATE is the alist element\n\
934 or the symbol from the obarray.\n\
936 If the optional fourth argument HIDE-SPACES is non-nil,\n\
937 strings in ALIST that start with a space\n\
938 are ignored unless STRING itself starts with a space.")
939 (string
, alist
, predicate
, hide_spaces
)
940 Lisp_Object string
, alist
, predicate
, hide_spaces
;
942 Lisp_Object tail
, elt
, eltstring
;
943 Lisp_Object allmatches
;
944 int list
= CONSP (alist
) || NILP (alist
);
946 Lisp_Object bucket
, tem
;
947 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
949 CHECK_STRING (string
, 0);
950 if (!list
&& !VECTORP (alist
))
952 return call3 (alist
, string
, predicate
, Qt
);
956 /* If ALIST is not a list, set TAIL just for gc pro. */
961 obsize
= XVECTOR (alist
)->size
;
962 bucket
= XVECTOR (alist
)->contents
[index
];
967 /* Get the next element of the alist or obarray. */
968 /* Exit the loop if the elements are all used up. */
969 /* elt gets the alist element or symbol.
970 eltstring gets the name to check as a completion. */
977 eltstring
= Fcar (elt
);
982 if (XFASTINT (bucket
) != 0)
985 eltstring
= Fsymbol_name (elt
);
986 if (XSYMBOL (bucket
)->next
)
987 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
989 XSETFASTINT (bucket
, 0);
991 else if (++index
>= obsize
)
995 bucket
= XVECTOR (alist
)->contents
[index
];
1000 /* Is this element a possible completion? */
1002 if (STRINGP (eltstring
)
1003 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
1004 /* If HIDE_SPACES, reject alternatives that start with space
1005 unless the input starts with space. */
1006 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
1007 || XSTRING (eltstring
)->data
[0] != ' '
1008 || NILP (hide_spaces
))
1009 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
1010 XSTRING (string
)->size
))
1013 Lisp_Object regexps
;
1015 XSETFASTINT (zero
, 0);
1017 /* Ignore this element if it fails to match all the regexps. */
1018 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
1019 regexps
= XCONS (regexps
)->cdr
)
1021 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
1025 if (CONSP (regexps
))
1028 /* Ignore this element if there is a predicate
1029 and the predicate doesn't like it. */
1031 if (!NILP (predicate
))
1033 if (EQ (predicate
, Qcommandp
))
1034 tem
= Fcommandp (elt
);
1037 GCPRO4 (tail
, eltstring
, allmatches
, string
);
1038 tem
= call1 (predicate
, elt
);
1041 if (NILP (tem
)) continue;
1043 /* Ok => put it on the list. */
1044 allmatches
= Fcons (eltstring
, allmatches
);
1048 return Fnreverse (allmatches
);
1051 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
1052 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
1053 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
1055 /* This comment supplies the doc string for completing-read,
1056 for make-docfile to see. We cannot put this in the real DEFUN
1057 due to limits in the Unix cpp.
1059 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
1060 "Read a string in the minibuffer, with completion.\n\
1061 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1062 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1063 PREDICATE limits completion to a subset of TABLE.\n\
1064 See `try-completion' and `all-completions' for more details
1065 on completion, TABLE, and PREDICATE.\n\
1067 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1068 the input is (or completes to) an element of TABLE or is null.\n\
1069 If it is also not t, Return does not exit if it does non-null completion.\n\
1070 If the input is null, `completing-read' returns an empty string,\n\
1071 regardless of the value of REQUIRE-MATCH.\n\
1073 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1074 If it is (STRING . POSITION), the initial input\n\
1075 is STRING, but point is placed POSITION characters into the string.\n\
1076 HIST, if non-nil, specifies a history list\n\
1077 and optionally the initial position in the list.\n\
1078 It can be a symbol, which is the history list variable to use,\n\
1079 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1080 In that case, HISTVAR is the history list variable to use,\n\
1081 and HISTPOS is the initial position (the position in the list\n\
1082 which INITIAL-CONTENTS corresponds to).\n\
1083 Positions are counted starting from 1 at the beginning of the list.\n\
1084 Completion ignores case if the ambient value of\n\
1085 `completion-ignore-case' is non-nil."
1087 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 6, 0,
1088 0 /* See immediately above */)
1089 (prompt
, table
, predicate
, require_match
, init
, hist
)
1090 Lisp_Object prompt
, table
, predicate
, require_match
, init
, hist
;
1092 Lisp_Object val
, histvar
, histpos
, position
;
1094 int count
= specpdl_ptr
- specpdl
;
1095 specbind (Qminibuffer_completion_table
, table
);
1096 specbind (Qminibuffer_completion_predicate
, predicate
);
1097 specbind (Qminibuffer_completion_confirm
,
1098 EQ (require_match
, Qt
) ? Qnil
: Qt
);
1099 last_exact_completion
= Qnil
;
1106 position
= Fcdr (init
);
1109 CHECK_STRING (init
, 0);
1110 if (!NILP (position
))
1112 CHECK_NUMBER (position
, 0);
1113 /* Convert to distance from end of input. */
1114 pos
= XINT (position
) - XSTRING (init
)->size
;
1125 histvar
= Fcar_safe (hist
);
1126 histpos
= Fcdr_safe (hist
);
1129 histvar
= Qminibuffer_history
;
1131 XSETFASTINT (histpos
, 0);
1133 val
= read_minibuf (NILP (require_match
)
1134 ? Vminibuffer_local_completion_map
1135 : Vminibuffer_local_must_match_map
,
1136 init
, prompt
, make_number (pos
), 0,
1138 return unbind_to (count
, val
);
1141 /* Temporarily display the string M at the end of the current
1142 minibuffer contents. This is used to display things like
1143 "[No Match]" when the user requests a completion for a prefix
1144 that has no possible completions, and other quick, unobtrusive
1147 temp_echo_area_glyphs (m
)
1152 Lisp_Object oinhibit
;
1153 oinhibit
= Vinhibit_quit
;
1155 /* Clear out any old echo-area message to make way for our new thing. */
1162 Fsit_for (make_number (2), Qnil
, Qnil
);
1163 del_range (osize
, ZV
);
1165 if (!NILP (Vquit_flag
))
1168 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1170 Vinhibit_quit
= oinhibit
;
1173 Lisp_Object
Fminibuffer_completion_help ();
1174 Lisp_Object
assoc_for_completion ();
1175 /* A subroutine of Fintern_soft. */
1176 extern Lisp_Object
oblookup ();
1179 /* Test whether TXT is an exact completion. */
1181 test_completion (txt
)
1186 if (CONSP (Vminibuffer_completion_table
)
1187 || NILP (Vminibuffer_completion_table
))
1188 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1189 else if (VECTORP (Vminibuffer_completion_table
))
1191 /* Bypass intern-soft as that loses for nil */
1192 tem
= oblookup (Vminibuffer_completion_table
,
1193 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1196 else if (!NILP (Vminibuffer_completion_predicate
))
1197 return call1 (Vminibuffer_completion_predicate
, tem
);
1202 return call3 (Vminibuffer_completion_table
, txt
,
1203 Vminibuffer_completion_predicate
, Qlambda
);
1207 * 0 no possible completion
1208 * 1 was already an exact and unique completion
1209 * 3 was already an exact completion
1210 * 4 completed to an exact completion
1211 * 5 some completion happened
1212 * 6 no completion happened
1217 Lisp_Object completion
, tem
;
1220 struct gcpro gcpro1
, gcpro2
;
1222 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1223 Vminibuffer_completion_predicate
);
1224 last
= last_exact_completion
;
1225 last_exact_completion
= Qnil
;
1227 GCPRO2 (completion
, last
);
1229 if (NILP (completion
))
1232 temp_echo_area_glyphs (" [No match]");
1237 if (EQ (completion
, Qt
)) /* exact and unique match */
1244 tem
= Fstring_equal (completion
, Fbuffer_string());
1245 if (completedp
= NILP (tem
))
1247 Ferase_buffer (); /* Some completion happened */
1248 Finsert (1, &completion
);
1251 /* It did find a match. Do we match some possibility exactly now? */
1252 tem
= test_completion (Fbuffer_string ());
1255 /* not an exact match */
1260 Fminibuffer_completion_help ();
1262 temp_echo_area_glyphs (" [Next char not unique]");
1265 else if (completedp
)
1270 /* If the last exact completion and this one were the same,
1271 it means we've already given a "Complete but not unique"
1272 message and the user's hit TAB again, so now we give him help. */
1273 last_exact_completion
= completion
;
1276 tem
= Fbuffer_string ();
1277 if (!NILP (Fequal (tem
, last
)))
1278 Fminibuffer_completion_help ();
1284 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1287 assoc_for_completion (key
, list
)
1288 register Lisp_Object key
;
1291 register Lisp_Object tail
;
1293 if (completion_ignore_case
)
1294 key
= Fupcase (key
);
1296 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1298 register Lisp_Object elt
, tem
, thiscar
;
1300 if (!CONSP (elt
)) continue;
1301 thiscar
= Fcar (elt
);
1302 if (!STRINGP (thiscar
))
1304 if (completion_ignore_case
)
1305 thiscar
= Fupcase (thiscar
);
1306 tem
= Fequal (thiscar
, key
);
1307 if (!NILP (tem
)) return elt
;
1313 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1314 "Complete the minibuffer contents as far as possible.\n\
1315 Return nil if there is no valid completion, else t.\n\
1316 If no characters can be completed, display a list of possible completions.\n\
1317 If you repeat this command after it displayed such a list,\n\
1318 scroll the window of possible completions.")
1322 Lisp_Object window
, tem
;
1324 /* If the previous command was not this, then mark the completion
1326 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1327 Vminibuf_scroll_window
= Qnil
;
1329 window
= Vminibuf_scroll_window
;
1330 /* If there's a fresh completion window with a live buffer,
1331 and this command is repeated, scroll that window. */
1332 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1333 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1335 struct buffer
*obuf
= current_buffer
;
1337 Fset_buffer (XWINDOW (window
)->buffer
);
1338 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1340 /* If end is in view, scroll up to the beginning. */
1341 Fset_window_start (window
, BEGV
, Qnil
);
1343 /* Else scroll down one screen. */
1344 Fscroll_other_window (Qnil
);
1346 set_buffer_internal (obuf
);
1350 i
= do_completion ();
1357 temp_echo_area_glyphs (" [Sole completion]");
1361 temp_echo_area_glyphs (" [Complete, but not unique]");
1368 /* Subroutines of Fminibuffer_complete_and_exit. */
1370 /* This one is called by internal_condition_case to do the real work. */
1373 complete_and_exit_1 ()
1375 return make_number (do_completion ());
1378 /* This one is called by internal_condition_case if an error happens.
1379 Pretend the current value is an exact match. */
1382 complete_and_exit_2 (ignore
)
1385 return make_number (1);
1388 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1389 Sminibuffer_complete_and_exit
, 0, 0, "",
1390 "If the minibuffer contents is a valid completion then exit.\n\
1391 Otherwise try to complete it. If completion leads to a valid completion,\n\
1392 a repetition of this command will exit.")
1398 /* Allow user to specify null string */
1402 if (!NILP (test_completion (Fbuffer_string ())))
1405 /* Call do_completion, but ignore errors. */
1406 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1407 complete_and_exit_2
);
1417 if (!NILP (Vminibuffer_completion_confirm
))
1419 temp_echo_area_glyphs (" [Confirm]");
1429 Fthrow (Qexit
, Qnil
);
1433 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1435 "Complete the minibuffer contents at most a single word.\n\
1436 After one word is completed as much as possible, a space or hyphen\n\
1437 is added, provided that matches some possible completion.\n\
1438 Return nil if there is no valid completion, else t.")
1441 Lisp_Object completion
, tem
;
1443 register unsigned char *completion_string
;
1444 struct gcpro gcpro1
, gcpro2
;
1446 /* We keep calling Fbuffer_string rather than arrange for GC to
1447 hold onto a pointer to one of the strings thus made. */
1449 completion
= Ftry_completion (Fbuffer_string (),
1450 Vminibuffer_completion_table
,
1451 Vminibuffer_completion_predicate
);
1452 if (NILP (completion
))
1455 temp_echo_area_glyphs (" [No match]");
1458 if (EQ (completion
, Qt
))
1461 #if 0 /* How the below code used to look, for reference. */
1462 tem
= Fbuffer_string ();
1463 b
= XSTRING (tem
)->data
;
1464 i
= ZV
- 1 - XSTRING (completion
)->size
;
1465 p
= XSTRING (completion
)->data
;
1467 0 <= scmp (b
, p
, ZV
- 1))
1470 /* Set buffer to longest match of buffer tail and completion head. */
1471 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1473 del_range (1, i
+ 1);
1476 #else /* Rewritten code */
1478 register unsigned char *buffer_string
;
1479 int buffer_length
, completion_length
;
1481 CHECK_STRING (completion
, 0);
1482 tem
= Fbuffer_string ();
1483 GCPRO2 (completion
, tem
);
1484 /* If reading a file name,
1485 expand any $ENVVAR refs in the buffer and in TEM. */
1486 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1488 Lisp_Object substituted
;
1489 substituted
= Fsubstitute_in_file_name (tem
);
1490 if (! EQ (substituted
, tem
))
1494 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1497 buffer_string
= XSTRING (tem
)->data
;
1498 completion_string
= XSTRING (completion
)->data
;
1499 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1500 completion_length
= XSTRING (completion
)->size
;
1501 i
= buffer_length
- completion_length
;
1502 /* Mly: I don't understand what this is supposed to do AT ALL */
1504 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1506 /* Set buffer to longest match of buffer tail and completion head. */
1510 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1512 del_range (1, i
+ 1);
1517 #endif /* Rewritten code */
1520 /* If completion finds next char not unique,
1521 consider adding a space or a hyphen. */
1522 if (i
== XSTRING (completion
)->size
)
1524 GCPRO1 (completion
);
1525 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1526 Vminibuffer_completion_table
,
1527 Vminibuffer_completion_predicate
);
1534 GCPRO1 (completion
);
1536 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1537 Vminibuffer_completion_table
,
1538 Vminibuffer_completion_predicate
);
1546 /* Now find first word-break in the stuff found by completion.
1547 i gets index in string of where to stop completing. */
1549 completion_string
= XSTRING (completion
)->data
;
1551 for (; i
< XSTRING (completion
)->size
; i
++)
1552 if (SYNTAX (completion_string
[i
]) != Sword
) break;
1553 if (i
< XSTRING (completion
)->size
)
1556 /* If got no characters, print help for user. */
1561 Fminibuffer_completion_help ();
1565 /* Otherwise insert in minibuffer the chars we got */
1568 insert_from_string (completion
, 0, i
, 1);
1572 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1574 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1575 Each element may be just a symbol or string\n\
1576 or may be a list of two strings to be printed as if concatenated.\n\
1577 `standard-output' must be a buffer.\n\
1578 At the end, run the normal hook `completion-setup-hook'.\n\
1579 It can find the completion buffer in `standard-output'.")
1581 Lisp_Object completions
;
1583 Lisp_Object tail
, elt
;
1586 struct gcpro gcpro1
, gcpro2
;
1587 struct buffer
*old
= current_buffer
;
1590 /* Note that (when it matters) every variable
1591 points to a non-string that is pointed to by COMPLETIONS,
1592 except for ELT. ELT can be pointing to a string
1593 when terpri or Findent_to calls a change hook. */
1595 GCPRO2 (completions
, elt
);
1597 if (BUFFERP (Vstandard_output
))
1598 set_buffer_internal (XBUFFER (Vstandard_output
));
1600 if (NILP (completions
))
1601 write_string ("There are no possible completions of what you have typed.",
1605 write_string ("Possible completions are:", -1);
1606 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1610 Lisp_Object startpos
, endpos
;
1613 /* Compute the length of this element. */
1617 CHECK_STRING (tem
, 0);
1618 length
= XINT (XSTRING (tem
)->size
);
1620 tem
= Fcar (Fcdr (elt
));
1621 CHECK_STRING (tem
, 0);
1622 length
+= XINT (XSTRING (tem
)->size
);
1626 CHECK_STRING (elt
, 0);
1627 length
= XINT (XSTRING (elt
)->size
);
1630 /* This does a bad job for narrower than usual windows.
1631 Sadly, the window it will appear in is not known
1632 until after the text has been made. */
1634 if (BUFFERP (Vstandard_output
))
1635 XSETINT (startpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1637 /* If the previous completion was very wide,
1638 or we have two on this line already,
1639 don't put another on the same line. */
1640 if (column
> 33 || first
1641 /* If this is really wide, don't put it second on a line. */
1642 || column
> 0 && length
> 45)
1647 /* Otherwise advance to column 35. */
1650 if (BUFFERP (Vstandard_output
))
1652 tem
= Findent_to (make_number (35), make_number (2));
1654 column
= XINT (tem
);
1660 write_string (" ", -1);
1663 while (column
< 35);
1667 if (BUFFERP (Vstandard_output
))
1669 XSETINT (endpos
, BUF_PT (XBUFFER (Vstandard_output
)));
1670 Fset_text_properties (startpos
, endpos
,
1671 Qnil
, Vstandard_output
);
1674 /* Output this element and update COLUMN. */
1677 Fprinc (Fcar (elt
), Qnil
);
1678 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1685 /* If output is to a buffer, recompute COLUMN in a way
1686 that takes account of character widths. */
1687 if (BUFFERP (Vstandard_output
))
1689 tem
= Fcurrent_column ();
1690 column
= XINT (tem
);
1699 if (BUFFERP (Vstandard_output
))
1700 set_buffer_internal (old
);
1702 if (!NILP (Vrun_hooks
))
1703 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1708 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1710 "Display a list of possible completions of the current minibuffer contents.")
1713 Lisp_Object completions
;
1715 message ("Making completion list...");
1716 completions
= Fall_completions (Fbuffer_string (),
1717 Vminibuffer_completion_table
,
1718 Vminibuffer_completion_predicate
,
1720 echo_area_glyphs
= 0;
1722 if (NILP (completions
))
1725 temp_echo_area_glyphs (" [No completions]");
1728 internal_with_output_to_temp_buffer ("*Completions*",
1729 Fdisplay_completion_list
,
1730 Fsort (completions
, Qstring_lessp
));
1734 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1735 "Terminate minibuffer input.")
1738 if (INTEGERP (last_command_char
))
1739 internal_self_insert (last_command_char
, 0);
1743 Fthrow (Qexit
, Qnil
);
1746 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1747 "Terminate this minibuffer argument.")
1750 Fthrow (Qexit
, Qnil
);
1753 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1754 "Return current depth of activations of minibuffer, a nonnegative integer.")
1757 return make_number (minibuf_level
);
1760 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1761 "Return the prompt string of the currently-active minibuffer.\n\
1762 If no minibuffer is active, return nil.")
1765 return Fcopy_sequence (minibuf_prompt
);
1768 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1769 Sminibuffer_prompt_width
, 0, 0, 0,
1770 "Return the display width of the minibuffer prompt.")
1774 XSETFASTINT (width
, minibuf_prompt_width
);
1778 init_minibuf_once ()
1780 Vminibuffer_list
= Qnil
;
1781 staticpro (&Vminibuffer_list
);
1787 minibuf_prompt
= Qnil
;
1788 staticpro (&minibuf_prompt
);
1790 minibuf_save_list
= Qnil
;
1791 staticpro (&minibuf_save_list
);
1793 Qread_file_name_internal
= intern ("read-file-name-internal");
1794 staticpro (&Qread_file_name_internal
);
1796 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1797 staticpro (&Qminibuffer_completion_table
);
1799 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1800 staticpro (&Qminibuffer_completion_confirm
);
1802 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1803 staticpro (&Qminibuffer_completion_predicate
);
1805 staticpro (&last_exact_completion
);
1806 last_exact_completion
= Qnil
;
1808 staticpro (&last_minibuf_string
);
1809 last_minibuf_string
= Qnil
;
1811 Quser_variable_p
= intern ("user-variable-p");
1812 staticpro (&Quser_variable_p
);
1814 Qminibuffer_history
= intern ("minibuffer-history");
1815 staticpro (&Qminibuffer_history
);
1817 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1818 staticpro (&Qminibuffer_setup_hook
);
1820 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1821 staticpro (&Qminibuffer_exit_hook
);
1823 Qhistory_length
= intern ("history-length");
1824 staticpro (&Qhistory_length
);
1826 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1827 "Normal hook run just after entry to minibuffer.");
1828 Vminibuffer_setup_hook
= Qnil
;
1830 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1831 "Normal hook run just after exit from minibuffer.");
1832 Vminibuffer_exit_hook
= Qnil
;
1834 DEFVAR_LISP ("history-length", &Vhistory_length
,
1835 "*Maximum length for history lists before truncation takes place.\n\
1836 A number means that length; t means infinite. Truncation takes place\n\
1837 just after a new element is inserted. Setting the history-length\n\
1838 property of a history variable overrides this default.");
1839 XSETFASTINT (Vhistory_length
, 30);
1841 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1842 "*Non-nil means automatically provide help for invalid completion input.");
1845 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
1846 "Non-nil means don't consider case significant in completion.");
1847 completion_ignore_case
= 0;
1849 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
1850 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1851 More precisely, this variable makes a difference when the minibuffer window\n\
1852 is the selected window. If you are in some other window, minibuffer commands\n\
1853 are allowed even if a minibuffer is active.");
1854 enable_recursive_minibuffers
= 0;
1856 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
1857 "Alist or obarray used for completion in the minibuffer.\n\
1858 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1860 The value may alternatively be a function, which is given three arguments:\n\
1861 STRING, the current buffer contents;\n\
1862 PREDICATE, the predicate for filtering possible matches;\n\
1863 CODE, which says what kind of things to do.\n\
1864 CODE can be nil, t or `lambda'.\n\
1865 nil means to return the best completion of STRING, or nil if there is none.\n\
1866 t means to return a list of all possible completions of STRING.\n\
1867 `lambda' means to return t if STRING is a valid completion as it stands.");
1868 Vminibuffer_completion_table
= Qnil
;
1870 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
1871 "Within call to `completing-read', this holds the PREDICATE argument.");
1872 Vminibuffer_completion_predicate
= Qnil
;
1874 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
1875 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1876 Vminibuffer_completion_confirm
= Qnil
;
1878 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
1879 "Value that `help-form' takes on inside the minibuffer.");
1880 Vminibuffer_help_form
= Qnil
;
1882 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
1883 "History list symbol to add minibuffer values to.\n\
1884 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
1886 (set minibuffer-history-variable\n\
1887 (cons STRING (symbol-value minibuffer-history-variable)))");
1888 XSETFASTINT (Vminibuffer_history_variable
, 0);
1890 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
1891 "Current position of redoing in the history list.");
1892 Vminibuffer_history_position
= Qnil
;
1894 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
1895 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1896 minibuffer_auto_raise
= 0;
1898 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
1899 "List of regexps that should restrict possible completions.");
1900 Vcompletion_regexp_list
= Qnil
;
1902 defsubr (&Sset_minibuffer_window
);
1903 defsubr (&Sread_from_minibuffer
);
1904 defsubr (&Seval_minibuffer
);
1905 defsubr (&Sread_minibuffer
);
1906 defsubr (&Sread_string
);
1907 defsubr (&Sread_command
);
1908 defsubr (&Sread_variable
);
1909 defsubr (&Sread_buffer
);
1910 defsubr (&Sread_no_blanks_input
);
1911 defsubr (&Sminibuffer_depth
);
1912 defsubr (&Sminibuffer_prompt
);
1913 defsubr (&Sminibuffer_prompt_width
);
1915 defsubr (&Stry_completion
);
1916 defsubr (&Sall_completions
);
1917 defsubr (&Scompleting_read
);
1918 defsubr (&Sminibuffer_complete
);
1919 defsubr (&Sminibuffer_complete_word
);
1920 defsubr (&Sminibuffer_complete_and_exit
);
1921 defsubr (&Sdisplay_completion_list
);
1922 defsubr (&Sminibuffer_completion_help
);
1924 defsubr (&Sself_insert_and_exit
);
1925 defsubr (&Sexit_minibuffer
);
1931 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
1932 "abort-recursive-edit");
1933 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
1935 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
1938 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
1939 "abort-recursive-edit");
1940 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
1942 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
1945 initial_define_key (Vminibuffer_local_ns_map
, ' ',
1947 initial_define_key (Vminibuffer_local_ns_map
, '\t',
1949 initial_define_key (Vminibuffer_local_ns_map
, '?',
1950 "self-insert-and-exit");
1952 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
1953 "abort-recursive-edit");
1954 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
1956 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
1959 initial_define_key (Vminibuffer_local_completion_map
, '\t',
1960 "minibuffer-complete");
1961 initial_define_key (Vminibuffer_local_completion_map
, ' ',
1962 "minibuffer-complete-word");
1963 initial_define_key (Vminibuffer_local_completion_map
, '?',
1964 "minibuffer-completion-help");
1966 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
1967 "abort-recursive-edit");
1968 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
1969 "minibuffer-complete-and-exit");
1970 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
1971 "minibuffer-complete-and-exit");
1972 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
1973 "minibuffer-complete");
1974 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
1975 "minibuffer-complete-word");
1976 initial_define_key (Vminibuffer_local_must_match_map
, '?',
1977 "minibuffer-completion-help");