1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995 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"
31 #define min(a, b) ((a) < (b) ? (a) : (b))
35 /* List of buffers for use as minibuffers.
36 The first element of the list is used for the outermost minibuffer
37 invocation, the next element is used for a recursive minibuffer
38 invocation, etc. The list is extended at the end as deeper
39 minibuffer recursions are encountered. */
40 Lisp_Object Vminibuffer_list
;
42 /* Data to remember during recursive minibuffer invocations */
43 Lisp_Object minibuf_save_list
;
45 /* Depth in minibuffer invocations. */
48 /* Nonzero means display completion help for invalid input */
51 /* Fread_minibuffer leaves the input here as a string. */
52 Lisp_Object last_minibuf_string
;
54 /* Nonzero means let functions called when within a minibuffer
55 invoke recursive minibuffers (to read arguments, or whatever) */
56 int enable_recursive_minibuffers
;
58 /* help-form is bound to this while in the minibuffer. */
60 Lisp_Object Vminibuffer_help_form
;
62 /* Variable which is the history list to add minibuffer values to. */
64 Lisp_Object Vminibuffer_history_variable
;
66 /* Current position in the history list (adjusted by M-n and M-p). */
68 Lisp_Object Vminibuffer_history_position
;
70 Lisp_Object Qminibuffer_history
;
72 Lisp_Object Qread_file_name_internal
;
74 /* Normal hooks for entry to and exit from minibuffer. */
76 Lisp_Object Qminibuffer_setup_hook
, Vminibuffer_setup_hook
;
77 Lisp_Object Qminibuffer_exit_hook
, Vminibuffer_exit_hook
;
79 /* Nonzero means completion ignores case. */
81 int completion_ignore_case
;
83 /* List of regexps that should restrict possible completions. */
85 Lisp_Object Vcompletion_regexp_list
;
87 /* Nonzero means raise the minibuffer frame when the minibuffer
90 int minibuffer_auto_raise
;
92 /* If last completion attempt reported "Complete but not unique"
93 then this is the string completed then; otherwise this is nil. */
95 static Lisp_Object last_exact_completion
;
97 Lisp_Object Quser_variable_p
;
99 /* Non-nil means it is the window for C-M-v to scroll
100 when the minibuffer is selected. */
101 extern Lisp_Object Vminibuf_scroll_window
;
103 extern Lisp_Object Voverriding_local_map
;
105 /* Actual minibuffer invocation. */
107 void read_minibuf_unwind ();
108 Lisp_Object
get_minibuffer ();
109 Lisp_Object
read_minibuf ();
111 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
112 (a string), putting point minus BACKUP_N chars from the end of INITIAL,
113 prompting with PROMPT (a string), using history list HISTVAR
114 with initial position HISTPOS. (BACKUP_N should be <= 0.)
116 Normally return the result as a string (the text that was read),
117 but if EXPFLAG is nonzero, read it and return the object read.
118 If HISTVAR is given, save the value read on that history only if it doesn't
119 match the front of that history list exactly. The value is pushed onto
120 the list as the string that was read. */
123 read_minibuf (map
, initial
, prompt
, backup_n
, expflag
, histvar
, histpos
)
127 Lisp_Object backup_n
;
133 int count
= specpdl_ptr
- specpdl
;
134 Lisp_Object mini_frame
;
135 struct gcpro gcpro1
, gcpro2
, gcpro3
;
137 single_kboard_state ();
140 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
141 store them away before we can GC. Don't need to protect
142 BACKUP_N because we use the value only if it is an integer. */
143 GCPRO3 (map
, initial
, val
);
145 if (!STRINGP (prompt
))
146 prompt
= build_string ("");
148 if (!enable_recursive_minibuffers
150 && (EQ (selected_window
, minibuf_window
)))
152 || selected_frame
!= XFRAME (WINDOW_FRAME (XWINDOW (minibuf_window
)))
154 error ("Command attempted to use minibuffer while in minibuffer");
156 /* Could we simply bind these variables instead? */
158 = Fcons (minibuf_prompt
,
159 Fcons (make_number (minibuf_prompt_width
),
161 Fcons (Vcurrent_prefix_arg
,
162 Fcons (Vminibuffer_history_position
,
163 Fcons (Vminibuffer_history_variable
,
164 Fcons (Voverriding_local_map
,
165 minibuf_save_list
)))))));
166 minibuf_prompt_width
= 0; /* xdisp.c puts in the right value. */
167 minibuf_prompt
= Fcopy_sequence (prompt
);
168 Vminibuffer_history_position
= histpos
;
169 Vminibuffer_history_variable
= histvar
;
171 record_unwind_protect (Fset_window_configuration
,
172 Fcurrent_window_configuration (Qnil
));
174 /* If the minibuffer window is on a different frame, save that
175 frame's configuration too. */
177 mini_frame
= WINDOW_FRAME (XWINDOW (minibuf_window
));
178 if (XFRAME (mini_frame
) != selected_frame
)
179 record_unwind_protect (Fset_window_configuration
,
180 Fcurrent_window_configuration (mini_frame
));
182 /* If the minibuffer is on an iconified or invisible frame,
183 make it visible now. */
184 Fmake_frame_visible (mini_frame
);
186 if (minibuffer_auto_raise
)
187 Fraise_frame (mini_frame
);
190 val
= current_buffer
->directory
;
191 Fset_buffer (get_minibuffer (minibuf_level
));
193 /* The current buffer's default directory is usually the right thing
194 for our minibuffer here. However, if you're typing a command at
195 a minibuffer-only frame when minibuf_level is zero, then buf IS
196 the current_buffer, so reset_buffer leaves buf's default
197 directory unchanged. This is a bummer when you've just started
198 up Emacs and buf's default directory is Qnil. Here's a hack; can
199 you think of something better to do? Find another buffer with a
200 better directory, and use that one instead. */
202 current_buffer
->directory
= val
;
205 Lisp_Object buf_list
;
207 for (buf_list
= Vbuffer_alist
;
209 buf_list
= XCONS (buf_list
)->cdr
)
211 Lisp_Object other_buf
;
213 other_buf
= XCONS (XCONS (buf_list
)->car
)->cdr
;
214 if (STRINGP (XBUFFER (other_buf
)->directory
))
216 current_buffer
->directory
= XBUFFER (other_buf
)->directory
;
223 if (XFRAME (mini_frame
) != selected_frame
)
224 Fredirect_frame_focus (Fselected_frame (), mini_frame
);
226 Fmake_local_variable (Qprint_escape_newlines
);
227 print_escape_newlines
= 1;
229 record_unwind_protect (read_minibuf_unwind
, Qnil
);
231 Vminibuf_scroll_window
= selected_window
;
232 Fset_window_buffer (minibuf_window
, Fcurrent_buffer ());
233 Fselect_window (minibuf_window
);
234 XSETFASTINT (XWINDOW (minibuf_window
)->hscroll
, 0);
241 Finsert (1, &initial
);
242 if (!NILP (backup_n
) && INTEGERP (backup_n
))
243 Fforward_char (backup_n
);
246 echo_area_glyphs
= 0;
247 /* This is in case the minibuffer-setup-hook calls Fsit_for. */
248 previous_echo_glyphs
= 0;
250 Vhelp_form
= Vminibuffer_help_form
;
251 current_buffer
->keymap
= map
;
253 /* Run our hook, but not if it is empty.
254 (run-hooks would do nothing if it is empty,
255 but it's important to save time here in the usual case. */
256 if (!NILP (Vminibuffer_setup_hook
) && !EQ (Vminibuffer_setup_hook
, Qunbound
)
257 && !NILP (Vrun_hooks
))
258 call1 (Vrun_hooks
, Qminibuffer_setup_hook
);
260 /* ??? MCC did redraw_screen here if switching screens. */
263 /* If cursor is on the minibuffer line,
264 show the user we have exited by putting it in column 0. */
265 if ((FRAME_CURSOR_Y (selected_frame
)
266 >= XFASTINT (XWINDOW (minibuf_window
)->top
))
269 FRAME_CURSOR_X (selected_frame
) = 0;
270 update_frame (selected_frame
, 1, 1);
273 /* Make minibuffer contents into a string */
274 val
= make_buffer_string (1, Z
);
275 bcopy (GAP_END_ADDR
, XSTRING (val
)->data
+ GPT
- BEG
, Z
- GPT
);
277 /* VAL is the string of minibuffer text. */
278 last_minibuf_string
= val
;
280 /* Add the value to the appropriate history list unless it is empty. */
281 if (XSTRING (val
)->size
!= 0
282 && SYMBOLP (Vminibuffer_history_variable
)
283 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
285 /* If the caller wanted to save the value read on a history list,
286 then do so if the value is not already the front of the list. */
288 histval
= Fsymbol_value (Vminibuffer_history_variable
);
290 /* The value of the history variable must be a cons or nil. Other
291 values are unacceptable. We silently ignore these values. */
294 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
295 Fset (Vminibuffer_history_variable
,
296 Fcons (last_minibuf_string
, histval
));
299 /* If Lisp form desired instead of string, parse it. */
302 Lisp_Object expr_and_pos
;
305 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
306 /* Ignore trailing whitespace; any other trailing junk is an error. */
307 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
308 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
309 error ("Trailing garbage following expression");
310 val
= Fcar (expr_and_pos
);
313 /* The appropriate frame will get selected
314 in set-window-configuration. */
315 RETURN_UNGCPRO (unbind_to (count
, val
));
318 /* Return a buffer to be used as the minibuffer at depth `depth'.
319 depth = 0 is the lowest allowed argument, and that is the value
320 used for nonrecursive minibuffer invocations */
323 get_minibuffer (depth
)
326 Lisp_Object tail
, num
, buf
;
328 extern Lisp_Object
nconc2 ();
330 XSETFASTINT (num
, depth
);
331 tail
= Fnthcdr (num
, Vminibuffer_list
);
334 tail
= Fcons (Qnil
, Qnil
);
335 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
338 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
340 sprintf (name
, " *Minibuf-%d*", depth
);
341 buf
= Fget_buffer_create (build_string (name
));
343 /* Although the buffer's name starts with a space, undo should be
345 Fbuffer_enable_undo (buf
);
347 XCONS (tail
)->car
= buf
;
351 int count
= specpdl_ptr
- specpdl
;
353 reset_buffer (XBUFFER (buf
));
354 record_unwind_protect (Fset_buffer
, Fcurrent_buffer ());
356 Fkill_all_local_variables ();
357 unbind_to (count
, Qnil
);
363 /* This function is called on exiting minibuffer, whether normally or not,
364 and it restores the current window, buffer, etc. */
367 read_minibuf_unwind (data
)
370 Lisp_Object old_deactivate_mark
;
372 /* We are exiting the minibuffer one way or the other,
374 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
375 && !NILP (Vrun_hooks
))
376 call1 (Vrun_hooks
, Qminibuffer_exit_hook
);
378 /* Erase the minibuffer we were using at this level. */
379 Fset_buffer (XWINDOW (minibuf_window
)->buffer
);
381 /* Prevent error in erase-buffer. */
382 current_buffer
->read_only
= Qnil
;
384 old_deactivate_mark
= Vdeactivate_mark
;
386 Vdeactivate_mark
= old_deactivate_mark
;
388 /* If this was a recursive minibuffer,
389 tie the minibuffer window back to the outer level minibuffer buffer */
391 /* Make sure minibuffer window is erased, not ignored */
392 windows_or_buffers_changed
++;
393 XSETFASTINT (XWINDOW (minibuf_window
)->last_modified
, 0);
395 /* Restore prompt, etc from outer minibuffer */
396 minibuf_prompt
= Fcar (minibuf_save_list
);
397 minibuf_save_list
= Fcdr (minibuf_save_list
);
398 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
399 minibuf_save_list
= Fcdr (minibuf_save_list
);
400 Vhelp_form
= Fcar (minibuf_save_list
);
401 minibuf_save_list
= Fcdr (minibuf_save_list
);
402 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
403 minibuf_save_list
= Fcdr (minibuf_save_list
);
404 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
405 minibuf_save_list
= Fcdr (minibuf_save_list
);
406 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
407 minibuf_save_list
= Fcdr (minibuf_save_list
);
408 Voverriding_local_map
= Fcar (minibuf_save_list
);
409 minibuf_save_list
= Fcdr (minibuf_save_list
);
413 /* This comment supplies the doc string for read-from-minibuffer,
414 for make-docfile to see. We cannot put this in the real DEFUN
415 due to limits in the Unix cpp.
417 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
418 "Read a string from the minibuffer, prompting with string PROMPT.\n\
419 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
420 to be inserted into the minibuffer before reading input.\n\
421 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
422 is STRING, but point is placed POSITION characters into the string.\n\
423 Third arg KEYMAP is a keymap to use whilst reading;\n\
424 if omitted or nil, the default is `minibuffer-local-map'.\n\
425 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
426 and return that object:\n\
427 in other words, do `(car (read-from-string INPUT-STRING))'\n\
428 Fifth arg HIST, if non-nil, specifies a history list\n\
429 and optionally the initial position in the list.\n\
430 It can be a symbol, which is the history list variable to use,\n\
431 or it can be a cons cell (HISTVAR . HISTPOS).\n\
432 In that case, HISTVAR is the history list variable to use,\n\
433 and HISTPOS is the initial position (the position in the list\n\
434 which INITIAL-CONTENTS corresponds to).\n\
435 Positions are counted starting from 1 at the beginning of the list."
438 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 5, 0,
439 0 /* See immediately above */)
440 (prompt
, initial_contents
, keymap
, read
, hist
)
441 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
;
444 Lisp_Object histvar
, histpos
, position
;
447 CHECK_STRING (prompt
, 0);
448 if (!NILP (initial_contents
))
450 if (CONSP (initial_contents
))
452 position
= Fcdr (initial_contents
);
453 initial_contents
= Fcar (initial_contents
);
455 CHECK_STRING (initial_contents
, 1);
456 if (!NILP (position
))
458 CHECK_NUMBER (position
, 0);
459 /* Convert to distance from end of input. */
460 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
465 keymap
= Vminibuffer_local_map
;
467 keymap
= get_keymap (keymap
,2);
476 histvar
= Fcar_safe (hist
);
477 histpos
= Fcdr_safe (hist
);
480 histvar
= Qminibuffer_history
;
482 XSETFASTINT (histpos
, 0);
484 return read_minibuf (keymap
, initial_contents
, prompt
,
485 make_number (pos
), !NILP (read
), histvar
, histpos
);
488 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
489 "Return a Lisp object read using the minibuffer.\n\
490 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
491 is a string to insert in the minibuffer before reading.")
492 (prompt
, initial_contents
)
493 Lisp_Object prompt
, initial_contents
;
495 CHECK_STRING (prompt
, 0);
496 if (!NILP (initial_contents
))
497 CHECK_STRING (initial_contents
, 1);
498 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
499 prompt
, Qnil
, 1, Qminibuffer_history
, make_number (0));
502 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
503 "Return value of Lisp expression read using the minibuffer.\n\
504 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
505 is a string to insert in the minibuffer before reading.")
506 (prompt
, initial_contents
)
507 Lisp_Object prompt
, initial_contents
;
509 return Feval (Fread_minibuffer (prompt
, initial_contents
));
512 /* Functions that use the minibuffer to read various things. */
514 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 3, 0,
515 "Read a string from the minibuffer, prompting with string PROMPT.\n\
516 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
517 The third arg HISTORY, if non-nil, specifies a history list\n\
518 and optionally the initial position in the list.\n\
519 See `read-from-minibuffer' for details of HISTORY argument.")
520 (prompt
, initial_input
, history
)
521 Lisp_Object prompt
, initial_input
, history
;
523 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
, Qnil
, history
);
526 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 2, 0,
527 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
528 Prompt with PROMPT, and provide INIT as an initial value of the input string.")
530 Lisp_Object prompt
, init
;
532 CHECK_STRING (prompt
, 0);
534 CHECK_STRING (init
, 1);
536 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
, 0,
537 Qminibuffer_history
, make_number (0));
540 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 1, 0,
541 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
542 Prompts with PROMPT.")
546 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
, Qnil
, Qnil
),
551 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
552 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
553 Prompts with PROMPT.")
557 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
),
562 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 1, 0,
563 "One arg PROMPT, a string. Read the name of a user variable and return\n\
564 it as a symbol. Prompts with PROMPT.\n\
565 A user variable is one whose documentation starts with a `*' character.")
569 return Fintern (Fcompleting_read (prompt
, Vobarray
,
570 Quser_variable_p
, Qt
, Qnil
, Qnil
),
574 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
575 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
576 Prompts with PROMPT.\n\
577 Optional second arg is value to return if user enters an empty line.\n\
578 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
579 (prompt
, def
, require_match
)
580 Lisp_Object prompt
, def
, require_match
;
587 def
= XBUFFER (def
)->name
;
590 args
[0] = build_string ("%s(default %s) ");
593 prompt
= Fformat (3, args
);
596 tem
= Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
, require_match
, Qnil
, Qnil
);
598 if (XSTRING (tem
)->size
)
603 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
604 "Return common substring of all completions of STRING in ALIST.\n\
605 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
606 All that match are compared together; the longest initial sequence\n\
607 common to all matches is returned as a string.\n\
608 If there is no match at all, nil is returned.\n\
609 For an exact match, t is returned.\n\
611 ALIST can be an obarray instead of an alist.\n\
612 Then the print names of all symbols in the obarray are the possible matches.\n\
614 ALIST can also be a function to do the completion itself.\n\
615 It receives three arguments: the values STRING, PREDICATE and nil.\n\
616 Whatever it returns becomes the value of `try-completion'.\n\
618 If optional third argument PREDICATE is non-nil,\n\
619 it is used to test each possible match.\n\
620 The match is a candidate only if PREDICATE returns non-nil.\n\
621 The argument given to PREDICATE is the alist element\n\
622 or the symbol from the obarray.")
623 (string
, alist
, pred
)
624 Lisp_Object string
, alist
, pred
;
626 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
628 int compare
, matchsize
;
629 int list
= CONSP (alist
) || NILP (alist
);
632 Lisp_Object bucket
, zero
, end
, tem
;
633 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
635 CHECK_STRING (string
, 0);
636 if (!list
&& !VECTORP (alist
))
637 return call3 (alist
, string
, pred
, Qnil
);
641 /* If ALIST is not a list, set TAIL just for gc pro. */
646 obsize
= XVECTOR (alist
)->size
;
647 bucket
= XVECTOR (alist
)->contents
[index
];
652 /* Get the next element of the alist or obarray. */
653 /* Exit the loop if the elements are all used up. */
654 /* elt gets the alist element or symbol.
655 eltstring gets the name to check as a completion. */
662 eltstring
= Fcar (elt
);
667 if (XFASTINT (bucket
) != 0)
670 eltstring
= Fsymbol_name (elt
);
671 if (XSYMBOL (bucket
)->next
)
672 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
674 XSETFASTINT (bucket
, 0);
676 else if (++index
>= obsize
)
680 bucket
= XVECTOR (alist
)->contents
[index
];
685 /* Is this element a possible completion? */
687 if (STRINGP (eltstring
)
688 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
689 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
690 XSTRING (string
)->size
))
695 XSETFASTINT (zero
, 0);
697 /* Ignore this element if it fails to match all the regexps. */
698 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
699 regexps
= XCONS (regexps
)->cdr
)
701 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
708 /* Ignore this element if there is a predicate
709 and the predicate doesn't like it. */
713 if (EQ (pred
, Qcommandp
))
714 tem
= Fcommandp (elt
);
717 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
718 tem
= call1 (pred
, elt
);
721 if (NILP (tem
)) continue;
724 /* Update computation of how much all possible completions match */
727 if (NILP (bestmatch
))
728 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
731 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
732 matchsize
= scmp (XSTRING (bestmatch
)->data
,
733 XSTRING (eltstring
)->data
,
737 if (completion_ignore_case
)
739 /* If this is an exact match except for case,
740 use it as the best match rather than one that is not an
741 exact match. This way, we get the case pattern
742 of the actual match. */
743 if ((matchsize
== XSTRING (eltstring
)->size
744 && matchsize
< XSTRING (bestmatch
)->size
)
746 /* If there is more than one exact match ignoring case,
747 and one of them is exact including case,
749 /* If there is no exact match ignoring case,
750 prefer a match that does not change the case
752 ((matchsize
== XSTRING (eltstring
)->size
)
754 (matchsize
== XSTRING (bestmatch
)->size
)
755 && !bcmp (XSTRING (eltstring
)->data
,
756 XSTRING (string
)->data
, XSTRING (string
)->size
)
757 && bcmp (XSTRING (bestmatch
)->data
,
758 XSTRING (string
)->data
, XSTRING (string
)->size
)))
759 bestmatch
= eltstring
;
761 bestmatchsize
= matchsize
;
766 if (NILP (bestmatch
))
767 return Qnil
; /* No completions found */
768 /* If we are ignoring case, and there is no exact match,
769 and no additional text was supplied,
770 don't change the case of what the user typed. */
771 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
772 && XSTRING (bestmatch
)->size
> bestmatchsize
)
775 /* Return t if the supplied string is an exact match (counting case);
776 it does not require any change to be made. */
777 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
778 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
782 XSETFASTINT (zero
, 0); /* Else extract the part in which */
783 XSETFASTINT (end
, bestmatchsize
); /* all completions agree */
784 return Fsubstring (bestmatch
, zero
, end
);
787 /* Compare exactly LEN chars of strings at S1 and S2,
788 ignoring case if appropriate.
789 Return -1 if strings match,
790 else number of chars that match at the beginning. */
794 register unsigned char *s1
, *s2
;
797 register int l
= len
;
799 if (completion_ignore_case
)
801 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
806 while (l
&& *s1
++ == *s2
++)
815 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 4, 0,
816 "Search for partial matches to STRING in ALIST.\n\
817 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
818 The value is a list of all the strings from ALIST that match.\n\
820 ALIST can be an obarray instead of an alist.\n\
821 Then the print names of all symbols in the obarray are the possible matches.\n\
823 ALIST can also be a function to do the completion itself.\n\
824 It receives three arguments: the values STRING, PREDICATE and t.\n\
825 Whatever it returns becomes the value of `all-completion'.\n\
827 If optional third argument PREDICATE is non-nil,\n\
828 it is used to test each possible match.\n\
829 The match is a candidate only if PREDICATE returns non-nil.\n\
830 The argument given to PREDICATE is the alist element\n\
831 or the symbol from the obarray.\n\
833 If the optional fourth argument HIDE-SPACES is non-nil,\n\
834 strings in ALIST that start with a space\n\
835 are ignored unless STRING itself starts with a space.")
836 (string
, alist
, pred
, hide_spaces
)
837 Lisp_Object string
, alist
, pred
, hide_spaces
;
839 Lisp_Object tail
, elt
, eltstring
;
840 Lisp_Object allmatches
;
841 int list
= CONSP (alist
) || NILP (alist
);
843 Lisp_Object bucket
, tem
;
844 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
846 CHECK_STRING (string
, 0);
847 if (!list
&& !VECTORP (alist
))
849 return call3 (alist
, string
, pred
, Qt
);
853 /* If ALIST is not a list, set TAIL just for gc pro. */
858 obsize
= XVECTOR (alist
)->size
;
859 bucket
= XVECTOR (alist
)->contents
[index
];
864 /* Get the next element of the alist or obarray. */
865 /* Exit the loop if the elements are all used up. */
866 /* elt gets the alist element or symbol.
867 eltstring gets the name to check as a completion. */
874 eltstring
= Fcar (elt
);
879 if (XFASTINT (bucket
) != 0)
882 eltstring
= Fsymbol_name (elt
);
883 if (XSYMBOL (bucket
)->next
)
884 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
886 XSETFASTINT (bucket
, 0);
888 else if (++index
>= obsize
)
892 bucket
= XVECTOR (alist
)->contents
[index
];
897 /* Is this element a possible completion? */
899 if (STRINGP (eltstring
)
900 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
901 /* If HIDE_SPACES, reject alternatives that start with space
902 unless the input starts with space. */
903 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
904 || XSTRING (eltstring
)->data
[0] != ' '
905 || NILP (hide_spaces
))
906 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
907 XSTRING (string
)->size
))
912 XSETFASTINT (zero
, 0);
914 /* Ignore this element if it fails to match all the regexps. */
915 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
916 regexps
= XCONS (regexps
)->cdr
)
918 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
925 /* Ignore this element if there is a predicate
926 and the predicate doesn't like it. */
930 if (EQ (pred
, Qcommandp
))
931 tem
= Fcommandp (elt
);
934 GCPRO4 (tail
, eltstring
, allmatches
, string
);
935 tem
= call1 (pred
, elt
);
938 if (NILP (tem
)) continue;
940 /* Ok => put it on the list. */
941 allmatches
= Fcons (eltstring
, allmatches
);
945 return Fnreverse (allmatches
);
948 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
949 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
950 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
952 /* This comment supplies the doc string for completing-read,
953 for make-docfile to see. We cannot put this in the real DEFUN
954 due to limits in the Unix cpp.
956 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
957 "Read a string in the minibuffer, with completion.\n\
958 Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
959 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
960 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
961 PREDICATE limits completion to a subset of TABLE.\n\
962 See `try-completion' and `all-completions' for more details
963 on completion, TABLE, and PREDICATE.\n\
965 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
966 the input is (or completes to) an element of TABLE or is null.\n\
967 If it is also not t, Return does not exit if it does non-null completion.\n\
968 If the input is null, `completing-read' returns nil,\n\
969 regardless of the value of REQUIRE-MATCH.\n\
971 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
972 If it is (STRING . POSITION), the initial input\n\
973 is STRING, but point is placed POSITION characters into the string.\n\
974 HIST, if non-nil, specifies a history list\n\
975 and optionally the initial position in the list.\n\
976 It can be a symbol, which is the history list variable to use,\n\
977 or it can be a cons cell (HISTVAR . HISTPOS).\n\
978 In that case, HISTVAR is the history list variable to use,\n\
979 and HISTPOS is the initial position (the position in the list\n\
980 which INITIAL-CONTENTS corresponds to).\n\
981 Positions are counted starting from 1 at the beginning of the list.\n\
982 Completion ignores case if the ambient value of\n\
983 `completion-ignore-case' is non-nil."
985 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 6, 0,
986 0 /* See immediately above */)
987 (prompt
, table
, pred
, require_match
, init
, hist
)
988 Lisp_Object prompt
, table
, pred
, require_match
, init
, hist
;
990 Lisp_Object val
, histvar
, histpos
, position
;
992 int count
= specpdl_ptr
- specpdl
;
993 specbind (Qminibuffer_completion_table
, table
);
994 specbind (Qminibuffer_completion_predicate
, pred
);
995 specbind (Qminibuffer_completion_confirm
,
996 EQ (require_match
, Qt
) ? Qnil
: Qt
);
997 last_exact_completion
= Qnil
;
1004 position
= Fcdr (init
);
1007 CHECK_STRING (init
, 0);
1008 if (!NILP (position
))
1010 CHECK_NUMBER (position
, 0);
1011 /* Convert to distance from end of input. */
1012 pos
= XINT (position
) - XSTRING (init
)->size
;
1023 histvar
= Fcar_safe (hist
);
1024 histpos
= Fcdr_safe (hist
);
1027 histvar
= Qminibuffer_history
;
1029 XSETFASTINT (histpos
, 0);
1031 val
= read_minibuf (NILP (require_match
)
1032 ? Vminibuffer_local_completion_map
1033 : Vminibuffer_local_must_match_map
,
1034 init
, prompt
, make_number (pos
), 0,
1036 return unbind_to (count
, val
);
1039 /* Temporarily display the string M at the end of the current
1040 minibuffer contents. This is used to display things like
1041 "[No Match]" when the user requests a completion for a prefix
1042 that has no possible completions, and other quick, unobtrusive
1045 temp_echo_area_glyphs (m
)
1049 Lisp_Object oinhibit
;
1050 oinhibit
= Vinhibit_quit
;
1052 /* Clear out any old echo-area message to make way for our new thing. */
1059 Fsit_for (make_number (2), Qnil
, Qnil
);
1061 if (!NILP (Vquit_flag
))
1064 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1066 Vinhibit_quit
= oinhibit
;
1069 Lisp_Object
Fminibuffer_completion_help ();
1070 Lisp_Object
assoc_for_completion ();
1071 /* A subroutine of Fintern_soft. */
1072 extern Lisp_Object
oblookup ();
1075 /* Test whether TXT is an exact completion. */
1077 test_completion (txt
)
1082 if (CONSP (Vminibuffer_completion_table
)
1083 || NILP (Vminibuffer_completion_table
))
1084 return assoc_for_completion (txt
, Vminibuffer_completion_table
);
1085 else if (VECTORP (Vminibuffer_completion_table
))
1087 /* Bypass intern-soft as that loses for nil */
1088 tem
= oblookup (Vminibuffer_completion_table
,
1089 XSTRING (txt
)->data
, XSTRING (txt
)->size
);
1092 else if (!NILP (Vminibuffer_completion_predicate
))
1093 return call1 (Vminibuffer_completion_predicate
, tem
);
1098 return call3 (Vminibuffer_completion_table
, txt
,
1099 Vminibuffer_completion_predicate
, Qlambda
);
1103 * 0 no possible completion
1104 * 1 was already an exact and unique completion
1105 * 3 was already an exact completion
1106 * 4 completed to an exact completion
1107 * 5 some completion happened
1108 * 6 no completion happened
1113 Lisp_Object completion
, tem
;
1116 struct gcpro gcpro1
, gcpro2
;
1118 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1119 Vminibuffer_completion_predicate
);
1120 last
= last_exact_completion
;
1121 last_exact_completion
= Qnil
;
1123 GCPRO2 (completion
, last
);
1125 if (NILP (completion
))
1128 temp_echo_area_glyphs (" [No match]");
1133 if (EQ (completion
, Qt
)) /* exact and unique match */
1140 tem
= Fstring_equal (completion
, Fbuffer_string());
1141 if (completedp
= NILP (tem
))
1143 Ferase_buffer (); /* Some completion happened */
1144 Finsert (1, &completion
);
1147 /* It did find a match. Do we match some possibility exactly now? */
1148 tem
= test_completion (Fbuffer_string ());
1151 /* not an exact match */
1156 Fminibuffer_completion_help ();
1158 temp_echo_area_glyphs (" [Next char not unique]");
1161 else if (completedp
)
1166 /* If the last exact completion and this one were the same,
1167 it means we've already given a "Complete but not unique"
1168 message and the user's hit TAB again, so now we give him help. */
1169 last_exact_completion
= completion
;
1172 tem
= Fbuffer_string ();
1173 if (!NILP (Fequal (tem
, last
)))
1174 Fminibuffer_completion_help ();
1180 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1183 assoc_for_completion (key
, list
)
1184 register Lisp_Object key
;
1187 register Lisp_Object tail
;
1189 if (completion_ignore_case
)
1190 key
= Fupcase (key
);
1192 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1194 register Lisp_Object elt
, tem
, thiscar
;
1196 if (!CONSP (elt
)) continue;
1197 thiscar
= Fcar (elt
);
1198 if (!STRINGP (thiscar
))
1200 if (completion_ignore_case
)
1201 thiscar
= Fupcase (thiscar
);
1202 tem
= Fequal (thiscar
, key
);
1203 if (!NILP (tem
)) return elt
;
1209 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1210 "Complete the minibuffer contents as far as possible.\n\
1211 Return nil if there is no valid completion, else t.\n\
1212 If no characters can be completed, display a list of possible completions.\n\
1213 If you repeat this command after it displayed such a list,\n\
1214 scroll the window of possible completions.")
1218 Lisp_Object window
, tem
;
1220 /* If the previous command was not this, then mark the completion
1222 if (! EQ (current_kboard
->Vlast_command
, this_command
))
1223 Vminibuf_scroll_window
= Qnil
;
1225 window
= Vminibuf_scroll_window
;
1226 /* If there's a fresh completion window with a live buffer,
1227 and this command is repeated, scroll that window. */
1228 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1229 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1231 struct buffer
*obuf
= current_buffer
;
1233 Fset_buffer (XWINDOW (window
)->buffer
);
1234 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1236 /* If end is in view, scroll up to the beginning. */
1237 Fset_window_start (window
, BEGV
, Qnil
);
1239 /* Else scroll down one screen. */
1240 Fscroll_other_window (Qnil
);
1242 set_buffer_internal (obuf
);
1246 i
= do_completion ();
1253 temp_echo_area_glyphs (" [Sole completion]");
1257 temp_echo_area_glyphs (" [Complete, but not unique]");
1264 /* Subroutines of Fminibuffer_complete_and_exit. */
1266 /* This one is called by internal_condition_case to do the real work. */
1269 complete_and_exit_1 ()
1271 return make_number (do_completion ());
1274 /* This one is called by internal_condition_case if an error happens.
1275 Pretend the current value is an exact match. */
1278 complete_and_exit_2 (ignore
)
1281 return make_number (1);
1284 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1285 Sminibuffer_complete_and_exit
, 0, 0, "",
1286 "If the minibuffer contents is a valid completion then exit.\n\
1287 Otherwise try to complete it. If completion leads to a valid completion,\n\
1288 a repetition of this command will exit.")
1294 /* Allow user to specify null string */
1298 if (!NILP (test_completion (Fbuffer_string ())))
1301 /* Call do_completion, but ignore errors. */
1302 val
= internal_condition_case (complete_and_exit_1
, Qerror
,
1303 complete_and_exit_2
);
1313 if (!NILP (Vminibuffer_completion_confirm
))
1315 temp_echo_area_glyphs (" [Confirm]");
1325 Fthrow (Qexit
, Qnil
);
1329 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1331 "Complete the minibuffer contents at most a single word.\n\
1332 After one word is completed as much as possible, a space or hyphen\n\
1333 is added, provided that matches some possible completion.\n\
1334 Return nil if there is no valid completion, else t.")
1337 Lisp_Object completion
, tem
;
1339 register unsigned char *completion_string
;
1340 struct gcpro gcpro1
, gcpro2
;
1342 /* We keep calling Fbuffer_string rather than arrange for GC to
1343 hold onto a pointer to one of the strings thus made. */
1345 completion
= Ftry_completion (Fbuffer_string (),
1346 Vminibuffer_completion_table
,
1347 Vminibuffer_completion_predicate
);
1348 if (NILP (completion
))
1351 temp_echo_area_glyphs (" [No match]");
1354 if (EQ (completion
, Qt
))
1357 #if 0 /* How the below code used to look, for reference. */
1358 tem
= Fbuffer_string ();
1359 b
= XSTRING (tem
)->data
;
1360 i
= ZV
- 1 - XSTRING (completion
)->size
;
1361 p
= XSTRING (completion
)->data
;
1363 0 <= scmp (b
, p
, ZV
- 1))
1366 /* Set buffer to longest match of buffer tail and completion head. */
1367 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1369 del_range (1, i
+ 1);
1372 #else /* Rewritten code */
1374 register unsigned char *buffer_string
;
1375 int buffer_length
, completion_length
;
1377 tem
= Fbuffer_string ();
1378 GCPRO2 (completion
, tem
);
1379 /* If reading a file name,
1380 expand any $ENVVAR refs in the buffer and in TEM. */
1381 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1383 Lisp_Object substituted
;
1384 substituted
= Fsubstitute_in_file_name (tem
);
1385 if (! EQ (substituted
, tem
))
1389 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1392 buffer_string
= XSTRING (tem
)->data
;
1393 completion_string
= XSTRING (completion
)->data
;
1394 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1395 completion_length
= XSTRING (completion
)->size
;
1396 i
= buffer_length
- completion_length
;
1397 /* Mly: I don't understand what this is supposed to do AT ALL */
1399 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1401 /* Set buffer to longest match of buffer tail and completion head. */
1405 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1407 del_range (1, i
+ 1);
1412 #endif /* Rewritten code */
1415 /* If completion finds next char not unique,
1416 consider adding a space or a hyphen. */
1417 if (i
== XSTRING (completion
)->size
)
1419 GCPRO1 (completion
);
1420 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1421 Vminibuffer_completion_table
,
1422 Vminibuffer_completion_predicate
);
1429 GCPRO1 (completion
);
1431 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1432 Vminibuffer_completion_table
,
1433 Vminibuffer_completion_predicate
);
1441 /* Now find first word-break in the stuff found by completion.
1442 i gets index in string of where to stop completing. */
1444 completion_string
= XSTRING (completion
)->data
;
1446 for (; i
< XSTRING (completion
)->size
; i
++)
1447 if (SYNTAX (completion_string
[i
]) != Sword
) break;
1448 if (i
< XSTRING (completion
)->size
)
1451 /* If got no characters, print help for user. */
1456 Fminibuffer_completion_help ();
1460 /* Otherwise insert in minibuffer the chars we got */
1463 insert_from_string (completion
, 0, i
, 1);
1467 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1469 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1470 Each element may be just a symbol or string\n\
1471 or may be a list of two strings to be printed as if concatenated.\n\
1472 `standard-output' must be a buffer.\n\
1473 At the end, run the normal hook `completion-setup-hook'.\n\
1474 It can find the completion buffer in `standard-output'.")
1476 Lisp_Object completions
;
1478 register Lisp_Object tail
, elt
;
1481 struct gcpro gcpro1
;
1482 struct buffer
*old
= current_buffer
;
1485 /* Note that (when it matters) every variable
1486 points to a non-string that is pointed to by COMPLETIONS. */
1487 GCPRO1 (completions
);
1489 if (BUFFERP (Vstandard_output
))
1490 set_buffer_internal (XBUFFER (Vstandard_output
));
1492 if (NILP (completions
))
1493 write_string ("There are no possible completions of what you have typed.",
1497 write_string ("Possible completions are:", -1);
1498 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1504 /* Compute the length of this element. */
1508 CHECK_STRING (tem
, 0);
1509 length
= XINT (XSTRING (tem
)->size
);
1511 tem
= Fcar (Fcdr (elt
));
1512 CHECK_STRING (tem
, 0);
1513 length
+= XINT (XSTRING (tem
)->size
);
1517 CHECK_STRING (elt
, 0);
1518 length
= XINT (XSTRING (elt
)->size
);
1521 /* This does a bad job for narrower than usual windows.
1522 Sadly, the window it will appear in is not known
1523 until after the text has been made. */
1525 /* If the previous completion was very wide,
1526 or we have two on this line already,
1527 don't put another on the same line. */
1528 if (column
> 33 || first
1529 /* If this is really wide, don't put it second on a line. */
1530 || column
> 0 && length
> 45)
1535 /* Otherwise advance to column 35. */
1538 if (BUFFERP (Vstandard_output
))
1540 tem
= Findent_to (make_number (35), make_number (2));
1541 column
= XINT (tem
);
1547 write_string (" ", -1);
1550 while (column
< 35);
1554 /* Output this element and update COLUMN. */
1557 Fprinc (Fcar (elt
), Qnil
);
1558 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1565 /* If output is to a buffer, recompute COLUMN in a way
1566 that takes account of character widths. */
1567 if (BUFFERP (Vstandard_output
))
1569 tem
= Fcurrent_column ();
1570 column
= XINT (tem
);
1579 if (BUFFERP (Vstandard_output
))
1580 set_buffer_internal (old
);
1582 if (!NILP (Vrun_hooks
))
1583 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1588 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1590 "Display a list of possible completions of the current minibuffer contents.")
1593 Lisp_Object completions
;
1595 message ("Making completion list...");
1596 completions
= Fall_completions (Fbuffer_string (),
1597 Vminibuffer_completion_table
,
1598 Vminibuffer_completion_predicate
,
1600 echo_area_glyphs
= 0;
1602 if (NILP (completions
))
1605 temp_echo_area_glyphs (" [No completions]");
1608 internal_with_output_to_temp_buffer ("*Completions*",
1609 Fdisplay_completion_list
,
1610 Fsort (completions
, Qstring_lessp
));
1614 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1615 "Terminate minibuffer input.")
1618 if (INTEGERP (last_command_char
))
1619 internal_self_insert (last_command_char
, 0);
1623 Fthrow (Qexit
, Qnil
);
1626 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1627 "Terminate this minibuffer argument.")
1630 Fthrow (Qexit
, Qnil
);
1633 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1634 "Return current depth of activations of minibuffer, a nonnegative integer.")
1637 return make_number (minibuf_level
);
1640 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1641 "Return the prompt string of the currently-active minibuffer.\n\
1642 If no minibuffer is active, return nil.")
1645 return Fcopy_sequence (minibuf_prompt
);
1648 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1649 Sminibuffer_prompt_width
, 0, 0, 0,
1650 "Return the display width of the minibuffer prompt.")
1654 XSETFASTINT (width
, minibuf_prompt_width
);
1658 init_minibuf_once ()
1660 Vminibuffer_list
= Qnil
;
1661 staticpro (&Vminibuffer_list
);
1667 minibuf_prompt
= Qnil
;
1668 staticpro (&minibuf_prompt
);
1670 minibuf_save_list
= Qnil
;
1671 staticpro (&minibuf_save_list
);
1673 Qread_file_name_internal
= intern ("read-file-name-internal");
1674 staticpro (&Qread_file_name_internal
);
1676 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1677 staticpro (&Qminibuffer_completion_table
);
1679 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1680 staticpro (&Qminibuffer_completion_confirm
);
1682 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1683 staticpro (&Qminibuffer_completion_predicate
);
1685 staticpro (&last_exact_completion
);
1686 last_exact_completion
= Qnil
;
1688 staticpro (&last_minibuf_string
);
1689 last_minibuf_string
= Qnil
;
1691 Quser_variable_p
= intern ("user-variable-p");
1692 staticpro (&Quser_variable_p
);
1694 Qminibuffer_history
= intern ("minibuffer-history");
1695 staticpro (&Qminibuffer_history
);
1697 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1698 staticpro (&Qminibuffer_setup_hook
);
1700 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1701 staticpro (&Qminibuffer_exit_hook
);
1703 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1704 "Normal hook run just after entry to minibuffer.");
1705 Vminibuffer_setup_hook
= Qnil
;
1707 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1708 "Normal hook run just after exit from minibuffer.");
1709 Vminibuffer_exit_hook
= Qnil
;
1711 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1712 "*Non-nil means automatically provide help for invalid completion input.");
1715 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
1716 "Non-nil means don't consider case significant in completion.");
1717 completion_ignore_case
= 0;
1719 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
1720 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1721 More precisely, this variable makes a difference when the minibuffer window\n\
1722 is the selected window. If you are in some other window, minibuffer commands\n\
1723 are allowed even if a minibuffer is active.");
1724 enable_recursive_minibuffers
= 0;
1726 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
1727 "Alist or obarray used for completion in the minibuffer.\n\
1728 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1730 The value may alternatively be a function, which is given three arguments:\n\
1731 STRING, the current buffer contents;\n\
1732 PREDICATE, the predicate for filtering possible matches;\n\
1733 CODE, which says what kind of things to do.\n\
1734 CODE can be nil, t or `lambda'.\n\
1735 nil means to return the best completion of STRING, or nil if there is none.\n\
1736 t means to return a list of all possible completions of STRING.\n\
1737 `lambda' means to return t if STRING is a valid completion as it stands.");
1738 Vminibuffer_completion_table
= Qnil
;
1740 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
1741 "Within call to `completing-read', this holds the PREDICATE argument.");
1742 Vminibuffer_completion_predicate
= Qnil
;
1744 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
1745 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1746 Vminibuffer_completion_confirm
= Qnil
;
1748 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
1749 "Value that `help-form' takes on inside the minibuffer.");
1750 Vminibuffer_help_form
= Qnil
;
1752 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
1753 "History list symbol to add minibuffer values to.\n\
1754 Each minibuffer output is added with\n\
1755 (set minibuffer-history-variable\n\
1756 (cons STRING (symbol-value minibuffer-history-variable)))");
1757 XSETFASTINT (Vminibuffer_history_variable
, 0);
1759 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
1760 "Current position of redoing in the history list.");
1761 Vminibuffer_history_position
= Qnil
;
1763 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
1764 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1765 minibuffer_auto_raise
= 0;
1767 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
1768 "List of regexps that should restrict possible completions.");
1769 Vcompletion_regexp_list
= Qnil
;
1771 defsubr (&Sread_from_minibuffer
);
1772 defsubr (&Seval_minibuffer
);
1773 defsubr (&Sread_minibuffer
);
1774 defsubr (&Sread_string
);
1775 defsubr (&Sread_command
);
1776 defsubr (&Sread_variable
);
1777 defsubr (&Sread_buffer
);
1778 defsubr (&Sread_no_blanks_input
);
1779 defsubr (&Sminibuffer_depth
);
1780 defsubr (&Sminibuffer_prompt
);
1781 defsubr (&Sminibuffer_prompt_width
);
1783 defsubr (&Stry_completion
);
1784 defsubr (&Sall_completions
);
1785 defsubr (&Scompleting_read
);
1786 defsubr (&Sminibuffer_complete
);
1787 defsubr (&Sminibuffer_complete_word
);
1788 defsubr (&Sminibuffer_complete_and_exit
);
1789 defsubr (&Sdisplay_completion_list
);
1790 defsubr (&Sminibuffer_completion_help
);
1792 defsubr (&Sself_insert_and_exit
);
1793 defsubr (&Sexit_minibuffer
);
1799 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
1800 "abort-recursive-edit");
1801 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
1803 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
1806 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
1807 "abort-recursive-edit");
1808 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
1810 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
1813 initial_define_key (Vminibuffer_local_ns_map
, ' ',
1815 initial_define_key (Vminibuffer_local_ns_map
, '\t',
1817 initial_define_key (Vminibuffer_local_ns_map
, '?',
1818 "self-insert-and-exit");
1820 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
1821 "abort-recursive-edit");
1822 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
1824 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
1827 initial_define_key (Vminibuffer_local_completion_map
, '\t',
1828 "minibuffer-complete");
1829 initial_define_key (Vminibuffer_local_completion_map
, ' ',
1830 "minibuffer-complete-word");
1831 initial_define_key (Vminibuffer_local_completion_map
, '?',
1832 "minibuffer-completion-help");
1834 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
1835 "abort-recursive-edit");
1836 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
1837 "minibuffer-complete-and-exit");
1838 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
1839 "minibuffer-complete-and-exit");
1840 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
1841 "minibuffer-complete");
1842 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
1843 "minibuffer-complete-word");
1844 initial_define_key (Vminibuffer_local_must_match_map
, '?',
1845 "minibuffer-completion-help");