1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994 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, 675 Mass Ave, Cambridge, MA 02139, USA. */
25 #include "dispextern.h"
30 #define min(a, b) ((a) < (b) ? (a) : (b))
34 /* List of buffers for use as minibuffers.
35 The first element of the list is used for the outermost minibuffer
36 invocation, the next element is used for a recursive minibuffer
37 invocation, etc. The list is extended at the end as deeper
38 minibuffer recursions are encountered. */
39 Lisp_Object Vminibuffer_list
;
41 /* Data to remember during recursive minibuffer invocations */
42 Lisp_Object minibuf_save_list
;
44 /* Depth in minibuffer invocations. */
47 /* Nonzero means display completion help for invalid input */
50 /* Fread_minibuffer leaves the input here as a string. */
51 Lisp_Object last_minibuf_string
;
53 /* Nonzero means let functions called when within a minibuffer
54 invoke recursive minibuffers (to read arguments, or whatever) */
55 int enable_recursive_minibuffers
;
57 /* help-form is bound to this while in the minibuffer. */
59 Lisp_Object Vminibuffer_help_form
;
61 /* Variable which is the history list to add minibuffer values to. */
63 Lisp_Object Vminibuffer_history_variable
;
65 /* Current position in the history list (adjusted by M-n and M-p). */
67 Lisp_Object Vminibuffer_history_position
;
69 Lisp_Object Qminibuffer_history
;
71 Lisp_Object Qread_file_name_internal
;
73 /* Normal hooks for entry to and exit from minibuffer. */
75 Lisp_Object Qminibuffer_setup_hook
, Vminibuffer_setup_hook
;
76 Lisp_Object Qminibuffer_exit_hook
, Vminibuffer_exit_hook
;
78 /* Nonzero means completion ignores case. */
80 int completion_ignore_case
;
82 /* List of regexps that should restrict possible completions. */
84 Lisp_Object Vcompletion_regexp_list
;
86 /* Nonzero means raise the minibuffer frame when the minibuffer
89 int minibuffer_auto_raise
;
91 /* If last completion attempt reported "Complete but not unique"
92 then this is the string completed then; otherwise this is nil. */
94 static Lisp_Object last_exact_completion
;
96 Lisp_Object Quser_variable_p
;
98 /* Non-nil means it is the window for C-M-v to scroll
99 when the minibuffer is selected. */
100 extern Lisp_Object Vminibuf_scroll_window
;
102 /* Actual minibuffer invocation. */
104 void read_minibuf_unwind ();
105 Lisp_Object
get_minibuffer ();
106 Lisp_Object
read_minibuf ();
108 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
109 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
110 prompting with PROMPT (a string), using history list HISTVAR
111 with initial position HISTPOS. (BACKUP_N should be <= 0.)
113 Normally return the result as a string (the text that was read),
114 but if EXPFLAG is non-nil, read it and return the object read.
115 If HISTVAR is given, save the value read on that history only if it doesn't
116 match the front of that history list exactly. The value is pushed onto
117 the list as the string that was read, or as the object that resulted iff
118 EXPFLAG is non-nil. */
121 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
, histvar
, histpos
)
125 Lisp_Object backup_n
;
130 register Lisp_Object val
;
131 int count
= specpdl_ptr
- specpdl
;
132 Lisp_Object mini_frame
;
134 if (XTYPE (prompt
) != Lisp_String
)
135 prompt
= build_string ("");
137 /* Emacs in -batch mode calls minibuffer: print the prompt. */
138 if (noninteractive
&& XTYPE (prompt
) == Lisp_String
)
139 printf ("%s", XSTRING (prompt
)->data
);
141 if (!enable_recursive_minibuffers
143 && (EQ (selected_window
, minibuf_window
)))
145 || selected_frame
!= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window
)))
147 error ("Command attempted to use minibuffer while in minibuffer");
149 /* Could we simply bind these variables instead? */
151 = Fcons (minibuf_prompt
,
152 Fcons (make_number (minibuf_prompt_width
),
154 Fcons (Vcurrent_prefix_arg
,
155 Fcons (Vminibuffer_history_position
,
156 Fcons (Vminibuffer_history_variable
,
157 minibuf_save_list
))))));
158 minibuf_prompt_width
= 0;
160 record_unwind_protect (Fset_window_configuration
,
161 Fcurrent_window_configuration (Qnil
));
163 /* If the minibuffer window is on a different frame, save that
164 frame's configuration too. */
166 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
167 if (XFRAME (mini_frame
) != selected_frame
)
168 record_unwind_protect (Fset_window_configuration
,
169 Fcurrent_window_configuration (mini_frame
));
171 /* If the minibuffer is on an iconified or invisible frame,
172 make it visible now. */
173 Fmake_frame_visible (mini_frame
);
175 if (minibuffer_auto_raise
)
176 Fraise_frame (mini_frame
);
179 val
= current_buffer
->directory
;
180 Fset_buffer (get_minibuffer (minibuf_level
));
182 /* The current buffer's default directory is usually the right thing
183 for our minibuffer here. However, if you're typing a command at
184 a minibuffer-only frame when minibuf_level is zero, then buf IS
185 the current_buffer, so reset_buffer leaves buf's default
186 directory unchanged. This is a bummer when you've just started
187 up Emacs and buf's default directory is Qnil. Here's a hack; can
188 you think of something better to do? Find another buffer with a
189 better directory, and use that one instead. */
190 if (XTYPE (val
) == Lisp_String
)
191 current_buffer
->directory
= val
;
194 Lisp_Object buf_list
;
196 for (buf_list
= Vbuffer_alist
;
198 buf_list
= XCONS (buf_list
)->cdr
)
200 Lisp_Object other_buf
;
202 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
203 if (XTYPE (XBUFFER (other_buf
)->directory
) == Lisp_String
)
205 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
212 if (XFRAME (mini_frame
) != selected_frame
)
213 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
215 Fmake_local_variable (Qprint_escape_newlines
);
216 print_escape_newlines
= 1;
218 record_unwind_protect (read_minibuf_unwind
, Qnil
);
220 Vminibuf_scroll_window
= selected_window
;
221 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
222 Fselect_window (minibuf_window
);
223 XFASTINT (XWINDOW (minibuf_window
)->hscroll
) = 0;
230 Finsert (1, &initial
);
231 if (!NILP (backup_n
) && XTYPE (backup_n
) == Lisp_Int
)
232 Fforward_char (backup_n
);
235 minibuf_prompt
= Fcopy_sequence (prompt
);
236 echo_area_glyphs
= 0;
237 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
238 previous_echo_glyphs
= 0;
240 Vhelp_form
= Vminibuffer_help_form
;
241 current_buffer
->keymap
= map
;
242 Vminibuffer_history_position
= histpos
;
243 Vminibuffer_history_variable
= histvar
;
245 /* Run our hook, but not if it is empty.
246 (run-hooks would do nothing if it is empty,
247 but it's important to save time here in the usual case. */
248 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
249 && !NILP (Vrun_hooks
))
250 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
252 /* ??? MCC did redraw_screen here if switching screens. */
255 /* If cursor is on the minibuffer line,
256 show the user we have exited by putting it in column 0. */
257 if ((FRAME_CURSOR_Y (selected_frame
)
258 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
261 FRAME_CURSOR_X (selected_frame
) = 0;
262 update_frame (selected_frame
, 1, 1);
265 /* Make minibuffer contents into a string */
266 val
= make_buffer_string (1, Z
);
267 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
269 /* VAL is the string of minibuffer text. */
270 last_minibuf_string
= val
;
272 /* Add the value to the appropriate history list unless it is empty. */
273 if (XSTRING (val
)->size
!= 0
274 && XTYPE (Vminibuffer_history_variable
) == Lisp_Symbol
275 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
277 /* If the caller wanted to save the value read on a history list,
278 then do so if the value is not already the front of the list. */
280 histval
= Fsymbol_value (Vminibuffer_history_variable
);
282 /* The value of the history variable must be a cons or nil. Other
283 values are unacceptable. We silently ignore these values. */
286 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
287 Fset (Vminibuffer_history_variable
,
288 Fcons (last_minibuf_string
, histval
));
291 /* If Lisp form desired instead of string, parse it. */
294 Lisp_Object expr_and_pos
;
297 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
298 /* Ignore trailing whitespace; any other trailing junk is an error. */
299 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
300 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
301 error ("Trailing garbage following expression");
302 val
= Fcar (expr_and_pos
);
305 return unbind_to (count
, val
); /* The appropriate frame will get selected
306 in set-window-configuration. */
309 /* Return a buffer to be used as the minibuffer at depth `depth'.
310 depth = 0 is the lowest allowed argument, and that is the value
311 used for nonrecursive minibuffer invocations */
314 get_minibuffer (depth
)
317 Lisp_Object tail
, num
, buf
;
319 extern Lisp_Object
nconc2 ();
321 XFASTINT (num
) = depth
;
322 tail
= Fnthcdr (num
, Vminibuffer_list
);
325 tail
= Fcons (Qnil
, Qnil
);
326 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
329 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
331 sprintf (name
, " *Minibuf-%d*", depth
);
332 buf
= Fget_buffer_create (build_string (name
));
334 /* Although the buffer's name starts with a space, undo should be
336 Fbuffer_enable_undo (buf
);
338 XCONS (tail
)->car
= buf
;
342 int count
= specpdl_ptr
- specpdl
;
344 reset_buffer (XBUFFER (buf
));
345 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
347 Fkill_all_local_variables ();
348 unbind_to (count
, Qnil
);
354 /* This function is called on exiting minibuffer, whether normally or not,
355 and it restores the current window, buffer, etc. */
358 read_minibuf_unwind (data
)
361 Lisp_Object old_deactivate_mark
;
363 /* We are exiting the minibuffer one way or the other,
365 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
366 && !NILP (Vrun_hooks
))
367 call1 (Vrun_hooks
, Qminibuffer_exit_hook
);
369 /* Erase the minibuffer we were using at this level. */
370 Fset_buffer (XWINDOW (minibuf_window
)->buffer
);
372 /* Prevent error in erase-buffer. */
373 current_buffer
->read_only
= Qnil
;
375 old_deactivate_mark
= Vdeactivate_mark
;
377 Vdeactivate_mark
= old_deactivate_mark
;
379 /* If this was a recursive minibuffer,
380 tie the minibuffer window back to the outer level minibuffer buffer */
382 /* Make sure minibuffer window is erased, not ignored */
383 windows_or_buffers_changed
++;
384 XFASTINT (XWINDOW (minibuf_window
)->last_modified
) = 0;
386 /* Restore prompt, etc from outer minibuffer */
387 minibuf_prompt
= Fcar (minibuf_save_list
);
388 minibuf_save_list
= Fcdr (minibuf_save_list
);
389 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
390 minibuf_save_list
= Fcdr (minibuf_save_list
);
391 Vhelp_form
= Fcar (minibuf_save_list
);
392 minibuf_save_list
= Fcdr (minibuf_save_list
);
393 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
394 minibuf_save_list
= Fcdr (minibuf_save_list
);
395 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
396 minibuf_save_list
= Fcdr (minibuf_save_list
);
397 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
398 minibuf_save_list
= Fcdr (minibuf_save_list
);
402 /* This comment supplies the doc string for read-from-minibuffer,
403 for make-docfile to see. We cannot put this in the real DEFUN
404 due to limits in the Unix cpp.
406 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
407 "Read a string from the minibuffer, prompting with string PROMPT.\n\
408 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
409 to be inserted into the minibuffer before reading input.\n\
410 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
411 is STRING, but point is placed POSITION characters into the string.\n\
412 Third arg KEYMAP is a keymap to use whilst reading;\n\
413 if omitted or nil, the default is `minibuffer-local-map'.\n\
414 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
415 and return that object:\n\
416 in other words, do `(car (read-from-string INPUT-STRING))'\n\
417 Fifth arg HIST, if non-nil, specifies a history list\n\
418 and optionally the initial position in the list.\n\
419 It can be a symbol, which is the history list variable to use,\n\
420 or it can be a cons cell (HISTVAR . HISTPOS).\n\
421 In that case, HISTVAR is the history list variable to use,\n\
422 and HISTPOS is the initial position (the position in the list\n\
423 which INITIAL-CONTENTS corresponds to).\n\
424 Positions are counted starting from 1 at the beginning of the list."
427 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 5, 0,
428 0 /* See immediately above */)
429 (prompt
, initial_contents
, keymap
, read
, hist
)
430 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
;
433 Lisp_Object histvar
, histpos
, position
;
436 CHECK_STRING (prompt
, 0);
437 if (!NILP (initial_contents
))
439 if (XTYPE (initial_contents
) == Lisp_Cons
)
441 position
= Fcdr (initial_contents
);
442 initial_contents
= Fcar (initial_contents
);
444 CHECK_STRING (initial_contents
, 1);
445 if (!NILP (position
))
447 CHECK_NUMBER (position
, 0);
448 /* Convert to distance from end of input. */
449 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
454 keymap
= Vminibuffer_local_map
;
456 keymap
= get_keymap (keymap
,2);
458 if (XTYPE (hist
) == Lisp_Symbol
)
465 histvar
= Fcar_safe (hist
);
466 histpos
= Fcdr_safe (hist
);
469 histvar
= Qminibuffer_history
;
471 XFASTINT (histpos
) = 0;
473 return read_minibuf (keymap
, initial_contents
, prompt
,
474 make_number (pos
), !NILP (read
), histvar
, histpos
);
477 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
478 "Return a Lisp object read using the minibuffer.\n\
479 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
480 is a string to insert in the minibuffer before reading.")
481 (prompt
, initial_contents
)
482 Lisp_Object prompt
, initial_contents
;
484 CHECK_STRING (prompt
, 0);
485 if (!NILP (initial_contents
))
486 CHECK_STRING (initial_contents
, 1);
487 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
488 prompt
, Qnil
, 1, Qminibuffer_history
, make_number (0));
491 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
492 "Return value of Lisp expression read using the minibuffer.\n\
493 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
494 is a string to insert in the minibuffer before reading.")
495 (prompt
, initial_contents
)
496 Lisp_Object prompt
, initial_contents
;
498 return Feval (Fread_minibuffer (prompt
, initial_contents
));
501 /* Functions that use the minibuffer to read various things. */
503 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 2, 0,
504 "Read a string from the minibuffer, prompting with string PROMPT.\n\
505 If non-nil second arg INITIAL-INPUT is a string to insert before reading.")
506 (prompt
, initial_input
)
507 Lisp_Object prompt
, initial_input
;
509 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
, Qnil
, Qnil
);
512 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 2, 0,
513 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
514 Prompt with PROMPT, and provide INIT as an initial value of the input string.")
516 Lisp_Object prompt
, init
;
518 CHECK_STRING (prompt
, 0);
520 CHECK_STRING (init
, 1);
522 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
, 0,
523 Qminibuffer_history
, make_number (0));
526 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 1, 0,
527 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
528 Prompts with PROMPT.")
532 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
, Qnil
, Qnil
),
537 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
538 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
539 Prompts with PROMPT.")
543 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
),
548 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 1, 0,
549 "One arg PROMPT, a string. Read the name of a user variable and return\n\
550 it as a symbol. Prompts with PROMPT.\n\
551 A user variable is one whose documentation starts with a `*' character.")
555 return Fintern (Fcompleting_read (prompt
, Vobarray
,
556 Quser_variable_p
, Qt
, Qnil
, Qnil
),
560 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
561 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
562 Prompts with PROMPT.\n\
563 Optional second arg is value to return if user enters an empty line.\n\
564 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
565 (prompt
, def
, require_match
)
566 Lisp_Object prompt
, def
, require_match
;
572 if (XTYPE (def
) == Lisp_Buffer
)
573 def
= XBUFFER (def
)->name
;
576 args
[0] = build_string ("%s(default %s) ");
579 prompt
= Fformat (3, args
);
582 tem
= Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
, require_match
, Qnil
, Qnil
);
584 if (XSTRING (tem
)->size
)
589 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
590 "Return common substring of all completions of STRING in ALIST.\n\
591 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
592 All that match are compared together; the longest initial sequence\n\
593 common to all matches is returned as a string.\n\
594 If there is no match at all, nil is returned.\n\
595 For an exact match, t is returned.\n\
597 ALIST can be an obarray instead of an alist.\n\
598 Then the print names of all symbols in the obarray are the possible matches.\n\
600 ALIST can also be a function to do the completion itself.\n\
601 It receives three arguments: the values STRING, PREDICATE and nil.\n\
602 Whatever it returns becomes the value of `try-completion'.\n\
604 If optional third argument PREDICATE is non-nil,\n\
605 it is used to test each possible match.\n\
606 The match is a candidate only if PREDICATE returns non-nil.\n\
607 The argument given to PREDICATE is the alist element or the symbol from the obarray.")
608 (string
, alist
, pred
)
609 Lisp_Object string
, alist
, pred
;
611 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
613 int compare
, matchsize
;
614 int list
= CONSP (alist
) || NILP (alist
);
617 Lisp_Object bucket
, zero
, end
, tem
;
618 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
620 CHECK_STRING (string
, 0);
621 if (!list
&& XTYPE (alist
) != Lisp_Vector
)
622 return call3 (alist
, string
, pred
, Qnil
);
626 /* If ALIST is not a list, set TAIL just for gc pro. */
631 obsize
= XVECTOR (alist
)->size
;
632 bucket
= XVECTOR (alist
)->contents
[index
];
637 /* Get the next element of the alist or obarray. */
638 /* Exit the loop if the elements are all used up. */
639 /* elt gets the alist element or symbol.
640 eltstring gets the name to check as a completion. */
647 eltstring
= Fcar (elt
);
652 if (XFASTINT (bucket
) != 0)
655 eltstring
= Fsymbol_name (elt
);
656 if (XSYMBOL (bucket
)->next
)
657 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
659 XFASTINT (bucket
) = 0;
661 else if (++index
>= obsize
)
665 bucket
= XVECTOR (alist
)->contents
[index
];
670 /* Is this element a possible completion? */
672 if (XTYPE (eltstring
) == Lisp_String
673 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
674 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
675 XSTRING (string
)->size
))
682 /* Ignore this element if it fails to match all the regexps. */
683 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
684 regexps
= XCONS (regexps
)->cdr
)
686 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
693 /* Ignore this element if there is a predicate
694 and the predicate doesn't like it. */
698 if (EQ (pred
, Qcommandp
))
699 tem
= Fcommandp (elt
);
702 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
703 tem
= call1 (pred
, elt
);
706 if (NILP (tem
)) continue;
709 /* Update computation of how much all possible completions match */
712 if (NILP (bestmatch
))
713 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
716 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
717 matchsize
= scmp (XSTRING (bestmatch
)->data
,
718 XSTRING (eltstring
)->data
,
722 if (completion_ignore_case
)
724 /* If this is an exact match except for case,
725 use it as the best match rather than one that is not an
726 exact match. This way, we get the case pattern
727 of the actual match. */
728 if ((matchsize
== XSTRING (eltstring
)->size
729 && matchsize
< XSTRING (bestmatch
)->size
)
731 /* If there is more than one exact match ignoring case,
732 and one of them is exact including case,
734 /* If there is no exact match ignoring case,
735 prefer a match that does not change the case
737 ((matchsize
== XSTRING (eltstring
)->size
)
739 (matchsize
== XSTRING (bestmatch
)->size
)
740 && !bcmp (XSTRING (eltstring
)->data
,
741 XSTRING (string
)->data
, XSTRING (string
)->size
)
742 && bcmp (XSTRING (bestmatch
)->data
,
743 XSTRING (string
)->data
, XSTRING (string
)->size
)))
744 bestmatch
= eltstring
;
746 bestmatchsize
= matchsize
;
751 if (NILP (bestmatch
))
752 return Qnil
; /* No completions found */
753 /* If we are ignoring case, and there is no exact match,
754 and no additional text was supplied,
755 don't change the case of what the user typed. */
756 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
757 && XSTRING (bestmatch
)->size
> bestmatchsize
)
760 /* Return t if the supplied string is an exact match (counting case);
761 it does not require any change to be made. */
762 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
763 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
767 XFASTINT (zero
) = 0; /* Else extract the part in which */
768 XFASTINT (end
) = bestmatchsize
; /* all completions agree */
769 return Fsubstring (bestmatch
, zero
, end
);
772 /* Compare exactly LEN chars of strings at S1 and S2,
773 ignoring case if appropriate.
774 Return -1 if strings match,
775 else number of chars that match at the beginning. */
778 register char *s1
, *s2
;
781 register int l
= len
;
783 if (completion_ignore_case
)
785 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
790 while (l
&& *s1
++ == *s2
++)
798 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 3, 0,
799 "Search for partial matches to STRING in ALIST.\n\
800 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
801 The value is a list of all the strings from ALIST that match.\n\
802 ALIST can be an obarray instead of an alist.\n\
803 Then the print names of all symbols in the obarray are the possible matches.\n\
805 ALIST can also be a function to do the completion itself.\n\
806 It receives three arguments: the values STRING, PREDICATE and t.\n\
807 Whatever it returns becomes the value of `all-completion'.\n\
809 If optional third argument PREDICATE is non-nil,\n\
810 it is used to test each possible match.\n\
811 The match is a candidate only if PREDICATE returns non-nil.\n\
812 The argument given to PREDICATE is the alist element or the symbol from the obarray.")
813 (string
, alist
, pred
)
814 Lisp_Object string
, alist
, pred
;
816 Lisp_Object tail
, elt
, eltstring
;
817 Lisp_Object allmatches
;
818 int list
= CONSP (alist
) || NILP (alist
);
820 Lisp_Object bucket
, tem
;
821 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
823 CHECK_STRING (string
, 0);
824 if (!list
&& XTYPE (alist
) != Lisp_Vector
)
826 return call3 (alist
, string
, pred
, Qt
);
830 /* If ALIST is not a list, set TAIL just for gc pro. */
835 obsize
= XVECTOR (alist
)->size
;
836 bucket
= XVECTOR (alist
)->contents
[index
];
841 /* Get the next element of the alist or obarray. */
842 /* Exit the loop if the elements are all used up. */
843 /* elt gets the alist element or symbol.
844 eltstring gets the name to check as a completion. */
851 eltstring
= Fcar (elt
);
856 if (XFASTINT (bucket
) != 0)
859 eltstring
= Fsymbol_name (elt
);
860 if (XSYMBOL (bucket
)->next
)
861 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
863 XFASTINT (bucket
) = 0;
865 else if (++index
>= obsize
)
869 bucket
= XVECTOR (alist
)->contents
[index
];
874 /* Is this element a possible completion? */
876 if (XTYPE (eltstring
) == Lisp_String
877 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
878 /* Reject alternatives that start with space
879 unless the input starts with space. */
880 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
881 || XSTRING (eltstring
)->data
[0] != ' ')
882 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
883 XSTRING (string
)->size
))
890 /* Ignore this element if it fails to match all the regexps. */
891 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
892 regexps
= XCONS (regexps
)->cdr
)
894 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
901 /* Ignore this element if there is a predicate
902 and the predicate doesn't like it. */
906 if (EQ (pred
, Qcommandp
))
907 tem
= Fcommandp (elt
);
910 GCPRO4 (tail
, eltstring
, allmatches
, string
);
911 tem
= call1 (pred
, elt
);
914 if (NILP (tem
)) continue;
916 /* Ok => put it on the list. */
917 allmatches
= Fcons (eltstring
, allmatches
);
921 return Fnreverse (allmatches
);
924 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
925 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
926 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
928 /* This comment supplies the doc string for completing-read,
929 for make-docfile to see. We cannot put this in the real DEFUN
930 due to limits in the Unix cpp.
932 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
933 "Read a string in the minibuffer, with completion.\n\
934 Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
935 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
936 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
937 PREDICATE limits completion to a subset of TABLE.\n\
938 See `try-completion' and `all-completions' for more details
939 on completion, TABLE, and PREDICATE.\n\
941 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
942 the input is (or completes to) an element of TABLE or is null.\n\
943 If it is also not t, Return does not exit if it does non-null completion.\n\
944 If the input is null, `completing-read' returns nil,\n\
945 regardless of the value of REQUIRE-MATCH.\n\
947 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
948 If it is (STRING . POSITION), the initial input\n\
949 is STRING, but point is placed POSITION characters into the string.\n\
950 HIST, if non-nil, specifies a history list\n\
951 and optionally the initial position in the list.\n\
952 It can be a symbol, which is the history list variable to use,\n\
953 or it can be a cons cell (HISTVAR . HISTPOS).\n\
954 In that case, HISTVAR is the history list variable to use,\n\
955 and HISTPOS is the initial position (the position in the list\n\
956 which INITIAL-CONTENTS corresponds to).\n\
957 Positions are counted starting from 1 at the beginning of the list.\n\
958 Completion ignores case if the ambient value of\n\
959 `completion-ignore-case' is non-nil."
961 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 6, 0,
962 0 /* See immediately above */)
963 (prompt
, table
, pred
, require_match
, init
, hist
)
964 Lisp_Object prompt
, table
, pred
, require_match
, init
, hist
;
966 Lisp_Object val
, histvar
, histpos
, position
;
968 int count
= specpdl_ptr
- specpdl
;
969 specbind (Qminibuffer_completion_table
, table
);
970 specbind (Qminibuffer_completion_predicate
, pred
);
971 specbind (Qminibuffer_completion_confirm
,
972 EQ (require_match
, Qt
) ? Qnil
: Qt
);
973 last_exact_completion
= Qnil
;
978 if (XTYPE (init
) == Lisp_Cons
)
980 position
= Fcdr (init
);
983 CHECK_STRING (init
, 0);
984 if (!NILP (position
))
986 CHECK_NUMBER (position
, 0);
987 /* Convert to distance from end of input. */
988 pos
= XINT (position
) - XSTRING (init
)->size
;
992 if (XTYPE (hist
) == Lisp_Symbol
)
999 histvar
= Fcar_safe (hist
);
1000 histpos
= Fcdr_safe (hist
);
1003 histvar
= Qminibuffer_history
;
1005 XFASTINT (histpos
) = 0;
1007 val
= read_minibuf (NILP (require_match
)
1008 ? Vminibuffer_local_completion_map
1009 : Vminibuffer_local_must_match_map
,
1010 init
, prompt
, make_number (pos
), 0,
1012 return unbind_to (count
, val
);
1015 /* Temporarily display the string M at the end of the current
1016 minibuffer contents. This is used to display things like
1017 "[No Match]" when the user requests a completion for a prefix
1018 that has no possible completions, and other quick, unobtrusive
1021 temp_echo_area_glyphs (m
)
1025 Lisp_Object oinhibit
;
1026 oinhibit
= Vinhibit_quit
;
1028 /* Clear out any old echo-area message to make way for our new thing. */
1035 Fsit_for (make_number (2), Qnil
, Qnil
);
1037 if (!NILP (Vquit_flag
))
1040 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1042 Vinhibit_quit
= oinhibit
;
1045 Lisp_Object
Fminibuffer_completion_help ();
1046 Lisp_Object
assoc_for_completion ();
1049 * 0 no possible completion
1050 * 1 was already an exact and unique completion
1051 * 3 was already an exact completion
1052 * 4 completed to an exact completion
1053 * 5 some completion happened
1054 * 6 no completion happened
1059 Lisp_Object completion
, tem
;
1062 struct gcpro gcpro1
, gcpro2
;
1064 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1065 Vminibuffer_completion_predicate
);
1066 last
= last_exact_completion
;
1067 last_exact_completion
= Qnil
;
1069 GCPRO2 (completion
, last
);
1071 if (NILP (completion
))
1074 temp_echo_area_glyphs (" [No match]");
1079 if (EQ (completion
, Qt
)) /* exact and unique match */
1086 tem
= Fstring_equal (completion
, Fbuffer_string());
1087 if (completedp
= NILP (tem
))
1089 Ferase_buffer (); /* Some completion happened */
1090 Finsert (1, &completion
);
1093 /* It did find a match. Do we match some possibility exactly now? */
1094 if (CONSP (Vminibuffer_completion_table
)
1095 || NILP (Vminibuffer_completion_table
))
1096 tem
= assoc_for_completion (Fbuffer_string (),
1097 Vminibuffer_completion_table
);
1098 else if (XTYPE (Vminibuffer_completion_table
) == Lisp_Vector
)
1100 /* the primitive used by Fintern_soft */
1101 extern Lisp_Object
oblookup ();
1103 tem
= Fbuffer_string ();
1104 /* Bypass intern-soft as that loses for nil */
1105 tem
= oblookup (Vminibuffer_completion_table
,
1106 XSTRING (tem
)->data
, XSTRING (tem
)->size
);
1107 if (XTYPE (tem
) != Lisp_Symbol
)
1109 else if (!NILP (Vminibuffer_completion_predicate
))
1110 tem
= call1 (Vminibuffer_completion_predicate
, tem
);
1115 tem
= call3 (Vminibuffer_completion_table
,
1117 Vminibuffer_completion_predicate
,
1122 /* not an exact match */
1127 Fminibuffer_completion_help ();
1129 temp_echo_area_glyphs (" [Next char not unique]");
1132 else if (completedp
)
1137 /* If the last exact completion and this one were the same,
1138 it means we've already given a "Complete but not unique"
1139 message and the user's hit TAB again, so now we give him help. */
1140 last_exact_completion
= completion
;
1143 tem
= Fbuffer_string ();
1144 if (!NILP (Fequal (tem
, last
)))
1145 Fminibuffer_completion_help ();
1151 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1154 assoc_for_completion (key
, list
)
1155 register Lisp_Object key
;
1158 register Lisp_Object tail
;
1160 if (completion_ignore_case
)
1161 key
= Fupcase (key
);
1163 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1165 register Lisp_Object elt
, tem
, thiscar
;
1167 if (!CONSP (elt
)) continue;
1168 thiscar
= Fcar (elt
);
1169 if (XTYPE (thiscar
) != Lisp_String
)
1171 if (completion_ignore_case
)
1172 thiscar
= Fupcase (thiscar
);
1173 tem
= Fequal (thiscar
, key
);
1174 if (!NILP (tem
)) return elt
;
1180 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1181 "Complete the minibuffer contents as far as possible.\n\
1182 Return nil if there is no valid completion, else t.\n\
1183 If no characters can be completed, display a list of possible completions.\n\
1184 If you repeat this command after it displayed such a list,\n\
1185 scroll the window of possible completions.")
1189 Lisp_Object window
, tem
;
1191 /* If the previous command was not this, then mark the completion
1193 if (! EQ (last_command
, this_command
))
1194 Vminibuf_scroll_window
= Qnil
;
1196 window
= Vminibuf_scroll_window
;
1197 /* If there's a fresh completion window with a live buffer,
1198 and this command is repeated, scroll that window. */
1199 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1200 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1202 struct buffer
*obuf
= current_buffer
;
1204 Fset_buffer (XWINDOW (window
)->buffer
);
1205 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1207 /* If end is in view, scroll up to the beginning. */
1208 Fset_window_start (window
, BEGV
, Qnil
);
1210 /* Else scroll down one screen. */
1211 Fscroll_other_window (Qnil
);
1213 set_buffer_internal (obuf
);
1217 i
= do_completion ();
1224 temp_echo_area_glyphs (" [Sole completion]");
1228 temp_echo_area_glyphs (" [Complete, but not unique]");
1235 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1236 Sminibuffer_complete_and_exit
, 0, 0, "",
1237 "Complete the minibuffer contents, and maybe exit.\n\
1238 Exit if the name is valid with no completion needed.\n\
1239 If name was completed to a valid match,\n\
1240 a repetition of this command will exit.")
1245 /* Allow user to specify null string */
1249 i
= do_completion ();
1257 if (!NILP (Vminibuffer_completion_confirm
))
1259 temp_echo_area_glyphs (" [Confirm]");
1269 Fthrow (Qexit
, Qnil
);
1273 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1275 "Complete the minibuffer contents at most a single word.\n\
1276 After one word is completed as much as possible, a space or hyphen\n\
1277 is added, provided that matches some possible completion.\n\
1278 Return nil if there is no valid completion, else t.")
1281 Lisp_Object completion
, tem
;
1283 register unsigned char *completion_string
;
1284 struct gcpro gcpro1
, gcpro2
;
1286 /* We keep calling Fbuffer_string rather than arrange for GC to
1287 hold onto a pointer to one of the strings thus made. */
1289 completion
= Ftry_completion (Fbuffer_string (),
1290 Vminibuffer_completion_table
,
1291 Vminibuffer_completion_predicate
);
1292 if (NILP (completion
))
1295 temp_echo_area_glyphs (" [No match]");
1298 if (EQ (completion
, Qt
))
1301 #if 0 /* How the below code used to look, for reference. */
1302 tem
= Fbuffer_string ();
1303 b
= XSTRING (tem
)->data
;
1304 i
= ZV
- 1 - XSTRING (completion
)->size
;
1305 p
= XSTRING (completion
)->data
;
1307 0 <= scmp (b
, p
, ZV
- 1))
1310 /* Set buffer to longest match of buffer tail and completion head. */
1311 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1313 del_range (1, i
+ 1);
1316 #else /* Rewritten code */
1318 register unsigned char *buffer_string
;
1319 int buffer_length
, completion_length
;
1321 tem
= Fbuffer_string ();
1322 GCPRO2 (completion
, tem
);
1323 /* If reading a file name,
1324 expand any $ENVVAR refs in the buffer and in TEM. */
1325 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1327 Lisp_Object substituted
;
1328 substituted
= Fsubstitute_in_file_name (tem
);
1329 if (! EQ (substituted
, tem
))
1333 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1336 buffer_string
= XSTRING (tem
)->data
;
1337 completion_string
= XSTRING (completion
)->data
;
1338 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1339 completion_length
= XSTRING (completion
)->size
;
1340 i
= buffer_length
- completion_length
;
1341 /* Mly: I don't understand what this is supposed to do AT ALL */
1343 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1345 /* Set buffer to longest match of buffer tail and completion head. */
1349 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1351 del_range (1, i
+ 1);
1356 #endif /* Rewritten code */
1359 /* If completion finds next char not unique,
1360 consider adding a space or a hyphen. */
1361 if (i
== XSTRING (completion
)->size
)
1363 GCPRO1 (completion
);
1364 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1365 Vminibuffer_completion_table
,
1366 Vminibuffer_completion_predicate
);
1369 if (XTYPE (tem
) == Lisp_String
)
1373 GCPRO1 (completion
);
1375 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1376 Vminibuffer_completion_table
,
1377 Vminibuffer_completion_predicate
);
1380 if (XTYPE (tem
) == Lisp_String
)
1385 /* Now find first word-break in the stuff found by completion.
1386 i gets index in string of where to stop completing. */
1388 completion_string
= XSTRING (completion
)->data
;
1390 for (; i
< XSTRING (completion
)->size
; i
++)
1391 if (SYNTAX (completion_string
[i
]) != Sword
) break;
1392 if (i
< XSTRING (completion
)->size
)
1395 /* If got no characters, print help for user. */
1400 Fminibuffer_completion_help ();
1404 /* Otherwise insert in minibuffer the chars we got */
1407 insert_from_string (completion
, 0, i
, 1);
1411 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1413 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1414 Each element may be just a symbol or string\n\
1415 or may be a list of two strings to be printed as if concatenated.\n\
1416 `standard-output' must be a buffer.\n\
1417 At the end, run the normal hook `completion-setup-hook'.\n\
1418 It can find the completion buffer in `standard-output'.")
1420 Lisp_Object completions
;
1422 register Lisp_Object tail
, elt
;
1425 struct gcpro gcpro1
;
1426 struct buffer
*old
= current_buffer
;
1428 /* Note that (when it matters) every variable
1429 points to a non-string that is pointed to by COMPLETIONS. */
1430 GCPRO1 (completions
);
1432 if (XTYPE (Vstandard_output
) == Lisp_Buffer
)
1433 set_buffer_internal (XBUFFER (Vstandard_output
));
1435 if (NILP (completions
))
1436 write_string ("There are no possible completions of what you have typed.",
1440 write_string ("Possible completions are:", -1);
1441 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1443 /* this needs fixing for the case of long completions
1444 and/or narrow windows */
1445 /* Sadly, the window it will appear in is not known
1446 until after the text has been made. */
1449 if (XTYPE (Vstandard_output
) == Lisp_Buffer
)
1450 Findent_to (make_number (35), make_number (2));
1455 write_string (" ", -1);
1458 while (column
< 35);
1469 if (XTYPE (Vstandard_output
) != Lisp_Buffer
)
1472 tem
= Flength (Fcar (elt
));
1473 column
+= XINT (tem
);
1474 tem
= Flength (Fcar (Fcdr (elt
)));
1475 column
+= XINT (tem
);
1477 Fprinc (Fcar (elt
), Qnil
);
1478 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1482 if (XTYPE (Vstandard_output
) != Lisp_Buffer
)
1485 tem
= Flength (elt
);
1486 column
+= XINT (tem
);
1495 if (XTYPE (Vstandard_output
) == Lisp_Buffer
)
1496 set_buffer_internal (old
);
1498 if (!NILP (Vrun_hooks
))
1499 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1504 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1506 "Display a list of possible completions of the current minibuffer contents.")
1509 Lisp_Object completions
;
1511 message ("Making completion list...");
1512 completions
= Fall_completions (Fbuffer_string (),
1513 Vminibuffer_completion_table
,
1514 Vminibuffer_completion_predicate
);
1515 echo_area_glyphs
= 0;
1517 if (NILP (completions
))
1520 temp_echo_area_glyphs (" [No completions]");
1523 internal_with_output_to_temp_buffer ("*Completions*",
1524 Fdisplay_completion_list
,
1525 Fsort (completions
, Qstring_lessp
));
1529 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1530 "Terminate minibuffer input.")
1533 if (XTYPE (last_command_char
) == Lisp_Int
)
1534 internal_self_insert (last_command_char
, 0);
1538 Fthrow (Qexit
, Qnil
);
1541 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1542 "Terminate this minibuffer argument.")
1545 Fthrow (Qexit
, Qnil
);
1548 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1549 "Return current depth of activations of minibuffer, a nonnegative integer.")
1552 return make_number (minibuf_level
);
1555 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1556 "Return the prompt string of the currently-active minibuffer.\n\
1557 If no minibuffer is active, return nil.")
1560 return Fcopy_sequence (minibuf_prompt
);
1563 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1564 Sminibuffer_prompt_width
, 0, 0, 0,
1565 "Return the display width of the minibuffer prompt.")
1569 XFASTINT (width
) = minibuf_prompt_width
;
1573 init_minibuf_once ()
1575 Vminibuffer_list
= Qnil
;
1576 staticpro (&Vminibuffer_list
);
1582 minibuf_prompt
= Qnil
;
1583 staticpro (&minibuf_prompt
);
1585 minibuf_save_list
= Qnil
;
1586 staticpro (&minibuf_save_list
);
1588 Qread_file_name_internal
= intern ("read-file-name-internal");
1589 staticpro (&Qread_file_name_internal
);
1591 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1592 staticpro (&Qminibuffer_completion_table
);
1594 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1595 staticpro (&Qminibuffer_completion_confirm
);
1597 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1598 staticpro (&Qminibuffer_completion_predicate
);
1600 staticpro (&last_exact_completion
);
1601 last_exact_completion
= Qnil
;
1603 staticpro (&last_minibuf_string
);
1604 last_minibuf_string
= Qnil
;
1606 Quser_variable_p
= intern ("user-variable-p");
1607 staticpro (&Quser_variable_p
);
1609 Qminibuffer_history
= intern ("minibuffer-history");
1610 staticpro (&Qminibuffer_history
);
1612 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1613 staticpro (&Qminibuffer_setup_hook
);
1615 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1616 staticpro (&Qminibuffer_exit_hook
);
1618 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1619 "Normal hook run just after entry to minibuffer.");
1620 Vminibuffer_setup_hook
= Qnil
;
1622 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1623 "Normal hook run just after exit from minibuffer.");
1624 Vminibuffer_exit_hook
= Qnil
;
1626 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1627 "*Non-nil means automatically provide help for invalid completion input.");
1630 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
1631 "Non-nil means don't consider case significant in completion.");
1632 completion_ignore_case
= 0;
1634 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
1635 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1636 More precisely, this variable makes a difference when the minibuffer window\n\
1637 is the selected window. If you are in some other window, minibuffer commands\n\
1638 are allowed even if a minibuffer is active.");
1639 enable_recursive_minibuffers
= 0;
1641 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
1642 "Alist or obarray used for completion in the minibuffer.\n\
1643 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1645 The value may alternatively be a function, which is given three arguments:\n\
1646 STRING, the current buffer contents;\n\
1647 PREDICATE, the predicate for filtering possible matches;\n\
1648 CODE, which says what kind of things to do.\n\
1649 CODE can be nil, t or `lambda'.\n\
1650 nil means to return the best completion of STRING, or nil if there is none.\n\
1651 t means to return a list of all possible completions of STRING.\n\
1652 `lambda' means to return t if STRING is a valid completion as it stands.");
1653 Vminibuffer_completion_table
= Qnil
;
1655 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
1656 "Within call to `completing-read', this holds the PREDICATE argument.");
1657 Vminibuffer_completion_predicate
= Qnil
;
1659 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
1660 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1661 Vminibuffer_completion_confirm
= Qnil
;
1663 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
1664 "Value that `help-form' takes on inside the minibuffer.");
1665 Vminibuffer_help_form
= Qnil
;
1667 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
1668 "History list symbol to add minibuffer values to.\n\
1669 Each minibuffer output is added with\n\
1670 (set minibuffer-history-variable\n\
1671 (cons STRING (symbol-value minibuffer-history-variable)))");
1672 XFASTINT (Vminibuffer_history_variable
) = 0;
1674 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
1675 "Current position of redoing in the history list.");
1676 Vminibuffer_history_position
= Qnil
;
1678 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
1679 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1680 minibuffer_auto_raise
= 0;
1682 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
1683 "List of regexps that should restrict possible completions.");
1684 Vcompletion_regexp_list
= Qnil
;
1686 defsubr (&Sread_from_minibuffer
);
1687 defsubr (&Seval_minibuffer
);
1688 defsubr (&Sread_minibuffer
);
1689 defsubr (&Sread_string
);
1690 defsubr (&Sread_command
);
1691 defsubr (&Sread_variable
);
1692 defsubr (&Sread_buffer
);
1693 defsubr (&Sread_no_blanks_input
);
1694 defsubr (&Sminibuffer_depth
);
1695 defsubr (&Sminibuffer_prompt
);
1696 defsubr (&Sminibuffer_prompt_width
);
1698 defsubr (&Stry_completion
);
1699 defsubr (&Sall_completions
);
1700 defsubr (&Scompleting_read
);
1701 defsubr (&Sminibuffer_complete
);
1702 defsubr (&Sminibuffer_complete_word
);
1703 defsubr (&Sminibuffer_complete_and_exit
);
1704 defsubr (&Sdisplay_completion_list
);
1705 defsubr (&Sminibuffer_completion_help
);
1707 defsubr (&Sself_insert_and_exit
);
1708 defsubr (&Sexit_minibuffer
);
1714 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
1715 "abort-recursive-edit");
1716 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
1718 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
1721 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
1722 "abort-recursive-edit");
1723 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
1725 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
1728 initial_define_key (Vminibuffer_local_ns_map
, ' ',
1730 initial_define_key (Vminibuffer_local_ns_map
, '\t',
1732 initial_define_key (Vminibuffer_local_ns_map
, '?',
1733 "self-insert-and-exit");
1735 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
1736 "abort-recursive-edit");
1737 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
1739 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
1742 initial_define_key (Vminibuffer_local_completion_map
, '\t',
1743 "minibuffer-complete");
1744 initial_define_key (Vminibuffer_local_completion_map
, ' ',
1745 "minibuffer-complete-word");
1746 initial_define_key (Vminibuffer_local_completion_map
, '?',
1747 "minibuffer-completion-help");
1749 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
1750 "abort-recursive-edit");
1751 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
1752 "minibuffer-complete-and-exit");
1753 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
1754 "minibuffer-complete-and-exit");
1755 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
1756 "minibuffer-complete");
1757 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
1758 "minibuffer-complete-word");
1759 initial_define_key (Vminibuffer_local_must_match_map
, '?',
1760 "minibuffer-completion-help");