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 XSET (mini_frame
, Lisp_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. */
273 if (XTYPE (Vminibuffer_history_variable
) == Lisp_Symbol
274 && ! EQ (XSYMBOL (Vminibuffer_history_variable
)->value
, Qunbound
))
276 /* If the caller wanted to save the value read on a history list,
277 then do so if the value is not already the front of the list. */
279 histval
= Fsymbol_value (Vminibuffer_history_variable
);
281 /* The value of the history variable must be a cons or nil. Other
282 values are unacceptable. We silently ignore these values. */
285 && NILP (Fequal (last_minibuf_string
, Fcar (histval
)))))
286 Fset (Vminibuffer_history_variable
,
287 Fcons (last_minibuf_string
, histval
));
290 /* If Lisp form desired instead of string, parse it. */
293 Lisp_Object expr_and_pos
;
296 expr_and_pos
= Fread_from_string (val
, Qnil
, Qnil
);
297 /* Ignore trailing whitespace; any other trailing junk is an error. */
298 for (p
= XSTRING (val
)->data
+ XINT (Fcdr (expr_and_pos
)); *p
; p
++)
299 if (*p
!= ' ' && *p
!= '\t' && *p
!= '\n')
300 error ("Trailing garbage following expression");
301 val
= Fcar (expr_and_pos
);
304 return unbind_to (count
, val
); /* The appropriate frame will get selected
305 in set-window-configuration. */
308 /* Return a buffer to be used as the minibuffer at depth `depth'.
309 depth = 0 is the lowest allowed argument, and that is the value
310 used for nonrecursive minibuffer invocations */
313 get_minibuffer (depth
)
316 Lisp_Object tail
, num
, buf
;
318 extern Lisp_Object
nconc2 ();
320 XFASTINT (num
) = depth
;
321 tail
= Fnthcdr (num
, Vminibuffer_list
);
324 tail
= Fcons (Qnil
, Qnil
);
325 Vminibuffer_list
= nconc2 (Vminibuffer_list
, tail
);
328 if (NILP (buf
) || NILP (XBUFFER (buf
)->name
))
330 sprintf (name
, " *Minibuf-%d*", depth
);
331 buf
= Fget_buffer_create (build_string (name
));
333 /* Although the buffer's name starts with a space, undo should be
335 Fbuffer_enable_undo (buf
);
337 XCONS (tail
)->car
= buf
;
340 reset_buffer (XBUFFER (buf
));
345 /* This function is called on exiting minibuffer, whether normally or not,
346 and it restores the current window, buffer, etc. */
349 read_minibuf_unwind (data
)
352 /* We are exiting the minibuffer one way or the other,
354 if (!NILP (Vminibuffer_exit_hook
) && !EQ (Vminibuffer_exit_hook
, Qunbound
)
355 && !NILP (Vrun_hooks
))
356 call1 (Vrun_hooks
, Qminibuffer_exit_hook
);
358 /* Erase the minibuffer we were using at this level. */
359 Fset_buffer (XWINDOW (minibuf_window
)->buffer
);
361 /* Prevent error in erase-buffer. */
362 current_buffer
->read_only
= Qnil
;
365 /* If this was a recursive minibuffer,
366 tie the minibuffer window back to the outer level minibuffer buffer */
368 /* Make sure minibuffer window is erased, not ignored */
369 windows_or_buffers_changed
++;
370 XFASTINT (XWINDOW (minibuf_window
)->last_modified
) = 0;
372 /* Restore prompt, etc from outer minibuffer */
373 minibuf_prompt
= Fcar (minibuf_save_list
);
374 minibuf_save_list
= Fcdr (minibuf_save_list
);
375 minibuf_prompt_width
= XFASTINT (Fcar (minibuf_save_list
));
376 minibuf_save_list
= Fcdr (minibuf_save_list
);
377 Vhelp_form
= Fcar (minibuf_save_list
);
378 minibuf_save_list
= Fcdr (minibuf_save_list
);
379 Vcurrent_prefix_arg
= Fcar (minibuf_save_list
);
380 minibuf_save_list
= Fcdr (minibuf_save_list
);
381 Vminibuffer_history_position
= Fcar (minibuf_save_list
);
382 minibuf_save_list
= Fcdr (minibuf_save_list
);
383 Vminibuffer_history_variable
= Fcar (minibuf_save_list
);
384 minibuf_save_list
= Fcdr (minibuf_save_list
);
388 /* This comment supplies the doc string for read-from-minibuffer,
389 for make-docfile to see. We cannot put this in the real DEFUN
390 due to limits in the Unix cpp.
392 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 5, 0,
393 "Read a string from the minibuffer, prompting with string PROMPT.\n\
394 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
395 to be inserted into the minibuffer before reading input.\n\
396 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
397 is STRING, but point is placed POSITION characters into the string.\n\
398 Third arg KEYMAP is a keymap to use whilst reading;\n\
399 if omitted or nil, the default is `minibuffer-local-map'.\n\
400 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
401 and return that object:\n\
402 in other words, do `(car (read-from-string INPUT-STRING))'\n\
403 Fifth arg HIST, if non-nil, specifies a history list\n\
404 and optionally the initial position in the list.\n\
405 It can be a symbol, which is the history list variable to use,\n\
406 or it can be a cons cell (HISTVAR . HISTPOS).\n\
407 In that case, HISTVAR is the history list variable to use,\n\
408 and HISTPOS is the initial position (the position in the list\n\
409 which INITIAL-CONTENTS corresponds to).\n\
410 Positions are counted starting from 1 at the beginning of the list."
413 DEFUN ("read-from-minibuffer", Fread_from_minibuffer
, Sread_from_minibuffer
, 1, 5, 0,
414 0 /* See immediately above */)
415 (prompt
, initial_contents
, keymap
, read
, hist
)
416 Lisp_Object prompt
, initial_contents
, keymap
, read
, hist
;
419 Lisp_Object histvar
, histpos
, position
;
422 CHECK_STRING (prompt
, 0);
423 if (!NILP (initial_contents
))
425 if (XTYPE (initial_contents
) == Lisp_Cons
)
427 position
= Fcdr (initial_contents
);
428 initial_contents
= Fcar (initial_contents
);
430 CHECK_STRING (initial_contents
, 1);
431 if (!NILP (position
))
433 CHECK_NUMBER (position
, 0);
434 /* Convert to distance from end of input. */
435 pos
= XINT (position
) - 1 - XSTRING (initial_contents
)->size
;
440 keymap
= Vminibuffer_local_map
;
442 keymap
= get_keymap (keymap
,2);
444 if (XTYPE (hist
) == Lisp_Symbol
)
451 histvar
= Fcar_safe (hist
);
452 histpos
= Fcdr_safe (hist
);
455 histvar
= Qminibuffer_history
;
457 XFASTINT (histpos
) = 0;
459 return read_minibuf (keymap
, initial_contents
, prompt
,
460 make_number (pos
), !NILP (read
), histvar
, histpos
);
463 DEFUN ("read-minibuffer", Fread_minibuffer
, Sread_minibuffer
, 1, 2, 0,
464 "Return a Lisp object read using the minibuffer.\n\
465 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
466 is a string to insert in the minibuffer before reading.")
467 (prompt
, initial_contents
)
468 Lisp_Object prompt
, initial_contents
;
470 CHECK_STRING (prompt
, 0);
471 if (!NILP (initial_contents
))
472 CHECK_STRING (initial_contents
, 1);
473 return read_minibuf (Vminibuffer_local_map
, initial_contents
,
474 prompt
, Qnil
, 1, Qminibuffer_history
, make_number (0));
477 DEFUN ("eval-minibuffer", Feval_minibuffer
, Seval_minibuffer
, 1, 2, 0,
478 "Return value of Lisp expression 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 return Feval (Fread_minibuffer (prompt
, initial_contents
));
487 /* Functions that use the minibuffer to read various things. */
489 DEFUN ("read-string", Fread_string
, Sread_string
, 1, 2, 0,
490 "Read a string from the minibuffer, prompting with string PROMPT.\n\
491 If non-nil second arg INITIAL-INPUT is a string to insert before reading.")
492 (prompt
, initial_input
)
493 Lisp_Object prompt
, initial_input
;
495 return Fread_from_minibuffer (prompt
, initial_input
, Qnil
, Qnil
, Qnil
);
498 DEFUN ("read-no-blanks-input", Fread_no_blanks_input
, Sread_no_blanks_input
, 1, 2, 0,
499 "Args PROMPT and INIT, strings. Read a string from the terminal, not allowing blanks.\n\
500 Prompt with PROMPT, and provide INIT as an initial value of the input string.")
502 Lisp_Object prompt
, init
;
504 CHECK_STRING (prompt
, 0);
506 CHECK_STRING (init
, 1);
508 return read_minibuf (Vminibuffer_local_ns_map
, init
, prompt
, Qnil
, 0,
509 Qminibuffer_history
, make_number (0));
512 DEFUN ("read-command", Fread_command
, Sread_command
, 1, 1, 0,
513 "One arg PROMPT, a string. Read the name of a command and return as a symbol.\n\
514 Prompts with PROMPT.")
518 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qcommandp
, Qt
, Qnil
, Qnil
),
523 DEFUN ("read-function", Fread_function
, Sread_function
, 1, 1, 0,
524 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
525 Prompts with PROMPT.")
529 return Fintern (Fcompleting_read (prompt
, Vobarray
, Qfboundp
, Qt
, Qnil
, Qnil
),
534 DEFUN ("read-variable", Fread_variable
, Sread_variable
, 1, 1, 0,
535 "One arg PROMPT, a string. Read the name of a user variable and return\n\
536 it as a symbol. Prompts with PROMPT.\n\
537 A user variable is one whose documentation starts with a `*' character.")
541 return Fintern (Fcompleting_read (prompt
, Vobarray
,
542 Quser_variable_p
, Qt
, Qnil
, Qnil
),
546 DEFUN ("read-buffer", Fread_buffer
, Sread_buffer
, 1, 3, 0,
547 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
548 Prompts with PROMPT.\n\
549 Optional second arg is value to return if user enters an empty line.\n\
550 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
551 (prompt
, def
, require_match
)
552 Lisp_Object prompt
, def
, require_match
;
558 if (XTYPE (def
) == Lisp_Buffer
)
559 def
= XBUFFER (def
)->name
;
562 args
[0] = build_string ("%s(default %s) ");
565 prompt
= Fformat (3, args
);
568 tem
= Fcompleting_read (prompt
, Vbuffer_alist
, Qnil
, require_match
, Qnil
, Qnil
);
570 if (XSTRING (tem
)->size
)
575 DEFUN ("try-completion", Ftry_completion
, Stry_completion
, 2, 3, 0,
576 "Return common substring of all completions of STRING in ALIST.\n\
577 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
578 All that match are compared together; the longest initial sequence\n\
579 common to all matches is returned as a string.\n\
580 If there is no match at all, nil is returned.\n\
581 For an exact match, t is returned.\n\
583 ALIST can be an obarray instead of an alist.\n\
584 Then the print names of all symbols in the obarray are the possible matches.\n\
586 ALIST can also be a function to do the completion itself.\n\
587 It receives three arguments: the values STRING, PREDICATE and nil.\n\
588 Whatever it returns becomes the value of `try-completion'.\n\
590 If optional third argument PREDICATE is non-nil,\n\
591 it is used to test each possible match.\n\
592 The match is a candidate only if PREDICATE returns non-nil.\n\
593 The argument given to PREDICATE is the alist element or the symbol from the obarray.")
594 (string
, alist
, pred
)
595 Lisp_Object string
, alist
, pred
;
597 Lisp_Object bestmatch
, tail
, elt
, eltstring
;
599 int compare
, matchsize
;
600 int list
= CONSP (alist
) || NILP (alist
);
603 Lisp_Object bucket
, zero
, end
, tem
;
604 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
606 CHECK_STRING (string
, 0);
607 if (!list
&& XTYPE (alist
) != Lisp_Vector
)
608 return call3 (alist
, string
, pred
, Qnil
);
612 /* If ALIST is not a list, set TAIL just for gc pro. */
617 obsize
= XVECTOR (alist
)->size
;
618 bucket
= XVECTOR (alist
)->contents
[index
];
623 /* Get the next element of the alist or obarray. */
624 /* Exit the loop if the elements are all used up. */
625 /* elt gets the alist element or symbol.
626 eltstring gets the name to check as a completion. */
633 eltstring
= Fcar (elt
);
638 if (XFASTINT (bucket
) != 0)
641 eltstring
= Fsymbol_name (elt
);
642 if (XSYMBOL (bucket
)->next
)
643 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
645 XFASTINT (bucket
) = 0;
647 else if (++index
>= obsize
)
651 bucket
= XVECTOR (alist
)->contents
[index
];
656 /* Is this element a possible completion? */
658 if (XTYPE (eltstring
) == Lisp_String
659 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
660 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
661 XSTRING (string
)->size
))
668 /* Ignore this element if it fails to match all the regexps. */
669 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
670 regexps
= XCONS (regexps
)->cdr
)
672 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
679 /* Ignore this element if there is a predicate
680 and the predicate doesn't like it. */
684 if (EQ (pred
, Qcommandp
))
685 tem
= Fcommandp (elt
);
688 GCPRO4 (tail
, string
, eltstring
, bestmatch
);
689 tem
= call1 (pred
, elt
);
692 if (NILP (tem
)) continue;
695 /* Update computation of how much all possible completions match */
698 if (NILP (bestmatch
))
699 bestmatch
= eltstring
, bestmatchsize
= XSTRING (eltstring
)->size
;
702 compare
= min (bestmatchsize
, XSTRING (eltstring
)->size
);
703 matchsize
= scmp (XSTRING (bestmatch
)->data
,
704 XSTRING (eltstring
)->data
,
708 if (completion_ignore_case
)
710 /* If this is an exact match except for case,
711 use it as the best match rather than one that is not an
712 exact match. This way, we get the case pattern
713 of the actual match. */
714 if ((matchsize
== XSTRING (eltstring
)->size
715 && matchsize
< XSTRING (bestmatch
)->size
)
717 /* If there is more than one exact match ignoring case,
718 and one of them is exact including case,
720 /* If there is no exact match ignoring case,
721 prefer a match that does not change the case
723 ((matchsize
== XSTRING (eltstring
)->size
)
725 (matchsize
== XSTRING (bestmatch
)->size
)
726 && !bcmp (XSTRING (eltstring
)->data
,
727 XSTRING (string
)->data
, XSTRING (string
)->size
)
728 && bcmp (XSTRING (bestmatch
)->data
,
729 XSTRING (string
)->data
, XSTRING (string
)->size
)))
730 bestmatch
= eltstring
;
732 bestmatchsize
= matchsize
;
737 if (NILP (bestmatch
))
738 return Qnil
; /* No completions found */
739 /* If we are ignoring case, and there is no exact match,
740 and no additional text was supplied,
741 don't change the case of what the user typed. */
742 if (completion_ignore_case
&& bestmatchsize
== XSTRING (string
)->size
743 && XSTRING (bestmatch
)->size
> bestmatchsize
)
746 /* Return t if the supplied string is an exact match (counting case);
747 it does not require any change to be made. */
748 if (matchcount
== 1 && bestmatchsize
== XSTRING (string
)->size
749 && !bcmp (XSTRING (bestmatch
)->data
, XSTRING (string
)->data
,
753 XFASTINT (zero
) = 0; /* Else extract the part in which */
754 XFASTINT (end
) = bestmatchsize
; /* all completions agree */
755 return Fsubstring (bestmatch
, zero
, end
);
758 /* Compare exactly LEN chars of strings at S1 and S2,
759 ignoring case if appropriate.
760 Return -1 if strings match,
761 else number of chars that match at the beginning. */
764 register char *s1
, *s2
;
767 register int l
= len
;
769 if (completion_ignore_case
)
771 while (l
&& DOWNCASE (*s1
++) == DOWNCASE (*s2
++))
776 while (l
&& *s1
++ == *s2
++)
784 DEFUN ("all-completions", Fall_completions
, Sall_completions
, 2, 3, 0,
785 "Search for partial matches to STRING in ALIST.\n\
786 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
787 The value is a list of all the strings from ALIST that match.\n\
788 ALIST can be an obarray instead of an alist.\n\
789 Then the print names of all symbols in the obarray are the possible matches.\n\
791 ALIST can also be a function to do the completion itself.\n\
792 It receives three arguments: the values STRING, PREDICATE and t.\n\
793 Whatever it returns becomes the value of `all-completion'.\n\
795 If optional third argument PREDICATE is non-nil,\n\
796 it is used to test each possible match.\n\
797 The match is a candidate only if PREDICATE returns non-nil.\n\
798 The argument given to PREDICATE is the alist element or the symbol from the obarray.")
799 (string
, alist
, pred
)
800 Lisp_Object string
, alist
, pred
;
802 Lisp_Object tail
, elt
, eltstring
;
803 Lisp_Object allmatches
;
804 int list
= CONSP (alist
) || NILP (alist
);
806 Lisp_Object bucket
, tem
;
807 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
809 CHECK_STRING (string
, 0);
810 if (!list
&& XTYPE (alist
) != Lisp_Vector
)
812 return call3 (alist
, string
, pred
, Qt
);
816 /* If ALIST is not a list, set TAIL just for gc pro. */
821 obsize
= XVECTOR (alist
)->size
;
822 bucket
= XVECTOR (alist
)->contents
[index
];
827 /* Get the next element of the alist or obarray. */
828 /* Exit the loop if the elements are all used up. */
829 /* elt gets the alist element or symbol.
830 eltstring gets the name to check as a completion. */
837 eltstring
= Fcar (elt
);
842 if (XFASTINT (bucket
) != 0)
845 eltstring
= Fsymbol_name (elt
);
846 if (XSYMBOL (bucket
)->next
)
847 XSETSYMBOL (bucket
, XSYMBOL (bucket
)->next
);
849 XFASTINT (bucket
) = 0;
851 else if (++index
>= obsize
)
855 bucket
= XVECTOR (alist
)->contents
[index
];
860 /* Is this element a possible completion? */
862 if (XTYPE (eltstring
) == Lisp_String
863 && XSTRING (string
)->size
<= XSTRING (eltstring
)->size
864 /* Reject alternatives that start with space
865 unless the input starts with space. */
866 && ((XSTRING (string
)->size
> 0 && XSTRING (string
)->data
[0] == ' ')
867 || XSTRING (eltstring
)->data
[0] != ' ')
868 && 0 > scmp (XSTRING (eltstring
)->data
, XSTRING (string
)->data
,
869 XSTRING (string
)->size
))
876 /* Ignore this element if it fails to match all the regexps. */
877 for (regexps
= Vcompletion_regexp_list
; CONSP (regexps
);
878 regexps
= XCONS (regexps
)->cdr
)
880 tem
= Fstring_match (XCONS (regexps
)->car
, eltstring
, zero
);
887 /* Ignore this element if there is a predicate
888 and the predicate doesn't like it. */
892 if (EQ (pred
, Qcommandp
))
893 tem
= Fcommandp (elt
);
896 GCPRO4 (tail
, eltstring
, allmatches
, string
);
897 tem
= call1 (pred
, elt
);
900 if (NILP (tem
)) continue;
902 /* Ok => put it on the list. */
903 allmatches
= Fcons (eltstring
, allmatches
);
907 return Fnreverse (allmatches
);
910 Lisp_Object Vminibuffer_completion_table
, Qminibuffer_completion_table
;
911 Lisp_Object Vminibuffer_completion_predicate
, Qminibuffer_completion_predicate
;
912 Lisp_Object Vminibuffer_completion_confirm
, Qminibuffer_completion_confirm
;
914 /* This comment supplies the doc string for completing-read,
915 for make-docfile to see. We cannot put this in the real DEFUN
916 due to limits in the Unix cpp.
918 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 6, 0,
919 "Read a string in the minibuffer, with completion.\n\
920 Args: PROMPT, TABLE, PREDICATE, REQUIRE-MATCH, INITIAL-INPUT, HIST.\n\
921 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
922 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
923 PREDICATE limits completion to a subset of TABLE.\n\
924 See `try-completion' for more details on completion, TABLE, and PREDICATE.\n\
925 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
926 the input is (or completes to) an element of TABLE or is null.\n\
927 If it is also not t, Return does not exit if it does non-null completion.\n\
928 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
929 If it is (STRING . POSITION), the initial input\n\
930 is STRING, but point is placed POSITION characters into the string.\n\
931 HIST, if non-nil, specifies a history list\n\
932 and optionally the initial position in the list.\n\
933 It can be a symbol, which is the history list variable to use,\n\
934 or it can be a cons cell (HISTVAR . HISTPOS).\n\
935 In that case, HISTVAR is the history list variable to use,\n\
936 and HISTPOS is the initial position (the position in the list\n\
937 which INITIAL-CONTENTS corresponds to).\n\
938 Positions are counted starting from 1 at the beginning of the list.\n\
939 Completion ignores case if the ambient value of\n\
940 `completion-ignore-case' is non-nil."
942 DEFUN ("completing-read", Fcompleting_read
, Scompleting_read
, 2, 6, 0,
943 0 /* See immediately above */)
944 (prompt
, table
, pred
, require_match
, init
, hist
)
945 Lisp_Object prompt
, table
, pred
, require_match
, init
, hist
;
947 Lisp_Object val
, histvar
, histpos
, position
;
949 int count
= specpdl_ptr
- specpdl
;
950 specbind (Qminibuffer_completion_table
, table
);
951 specbind (Qminibuffer_completion_predicate
, pred
);
952 specbind (Qminibuffer_completion_confirm
,
953 EQ (require_match
, Qt
) ? Qnil
: Qt
);
954 last_exact_completion
= Qnil
;
959 if (XTYPE (init
) == Lisp_Cons
)
961 position
= Fcdr (init
);
964 CHECK_STRING (init
, 0);
965 if (!NILP (position
))
967 CHECK_NUMBER (position
, 0);
968 /* Convert to distance from end of input. */
969 pos
= XINT (position
) - XSTRING (init
)->size
;
973 if (XTYPE (hist
) == Lisp_Symbol
)
980 histvar
= Fcar_safe (hist
);
981 histpos
= Fcdr_safe (hist
);
984 histvar
= Qminibuffer_history
;
986 XFASTINT (histpos
) = 0;
988 val
= read_minibuf (NILP (require_match
)
989 ? Vminibuffer_local_completion_map
990 : Vminibuffer_local_must_match_map
,
991 init
, prompt
, make_number (pos
), 0,
993 return unbind_to (count
, val
);
996 /* Temporarily display the string M at the end of the current
997 minibuffer contents. This is used to display things like
998 "[No Match]" when the user requests a completion for a prefix
999 that has no possible completions, and other quick, unobtrusive
1002 temp_echo_area_glyphs (m
)
1006 Lisp_Object oinhibit
;
1007 oinhibit
= Vinhibit_quit
;
1009 /* Clear out any old echo-area message to make way for our new thing. */
1016 Fsit_for (make_number (2), Qnil
, Qnil
);
1018 if (!NILP (Vquit_flag
))
1021 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1023 Vinhibit_quit
= oinhibit
;
1026 Lisp_Object
Fminibuffer_completion_help ();
1027 Lisp_Object
assoc_for_completion ();
1030 * 0 no possible completion
1031 * 1 was already an exact and unique completion
1032 * 3 was already an exact completion
1033 * 4 completed to an exact completion
1034 * 5 some completion happened
1035 * 6 no completion happened
1040 Lisp_Object completion
, tem
;
1043 struct gcpro gcpro1
, gcpro2
;
1045 completion
= Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table
,
1046 Vminibuffer_completion_predicate
);
1047 last
= last_exact_completion
;
1048 last_exact_completion
= Qnil
;
1050 GCPRO2 (completion
, last
);
1052 if (NILP (completion
))
1055 temp_echo_area_glyphs (" [No match]");
1060 if (EQ (completion
, Qt
)) /* exact and unique match */
1067 tem
= Fstring_equal (completion
, Fbuffer_string());
1068 if (completedp
= NILP (tem
))
1070 Ferase_buffer (); /* Some completion happened */
1071 Finsert (1, &completion
);
1074 /* It did find a match. Do we match some possibility exactly now? */
1075 if (CONSP (Vminibuffer_completion_table
)
1076 || NILP (Vminibuffer_completion_table
))
1077 tem
= assoc_for_completion (Fbuffer_string (),
1078 Vminibuffer_completion_table
);
1079 else if (XTYPE (Vminibuffer_completion_table
) == Lisp_Vector
)
1081 /* the primitive used by Fintern_soft */
1082 extern Lisp_Object
oblookup ();
1084 tem
= Fbuffer_string ();
1085 /* Bypass intern-soft as that loses for nil */
1086 tem
= oblookup (Vminibuffer_completion_table
,
1087 XSTRING (tem
)->data
, XSTRING (tem
)->size
);
1088 if (XTYPE (tem
) != Lisp_Symbol
)
1090 else if (!NILP (Vminibuffer_completion_predicate
))
1091 tem
= call1 (Vminibuffer_completion_predicate
, tem
);
1096 tem
= call3 (Vminibuffer_completion_table
,
1098 Vminibuffer_completion_predicate
,
1103 /* not an exact match */
1108 Fminibuffer_completion_help ();
1110 temp_echo_area_glyphs (" [Next char not unique]");
1113 else if (completedp
)
1118 /* If the last exact completion and this one were the same,
1119 it means we've already given a "Complete but not unique"
1120 message and the user's hit TAB again, so now we give him help. */
1121 last_exact_completion
= completion
;
1124 tem
= Fbuffer_string ();
1125 if (!NILP (Fequal (tem
, last
)))
1126 Fminibuffer_completion_help ();
1132 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1135 assoc_for_completion (key
, list
)
1136 register Lisp_Object key
;
1139 register Lisp_Object tail
;
1141 if (completion_ignore_case
)
1142 key
= Fupcase (key
);
1144 for (tail
= list
; !NILP (tail
); tail
= Fcdr (tail
))
1146 register Lisp_Object elt
, tem
, thiscar
;
1148 if (!CONSP (elt
)) continue;
1149 thiscar
= Fcar (elt
);
1150 if (XTYPE (thiscar
) != Lisp_String
)
1152 if (completion_ignore_case
)
1153 thiscar
= Fupcase (thiscar
);
1154 tem
= Fequal (thiscar
, key
);
1155 if (!NILP (tem
)) return elt
;
1161 DEFUN ("minibuffer-complete", Fminibuffer_complete
, Sminibuffer_complete
, 0, 0, "",
1162 "Complete the minibuffer contents as far as possible.\n\
1163 Return nil if there is no valid completion, else t.\n\
1164 If no characters can be completed, display a list of possible completions.\n\
1165 If you repeat this command after it displayed such a list,\n\
1166 scroll the window of possible completions.")
1170 Lisp_Object window
, tem
;
1172 /* If the previous command was not this, then mark the completion
1174 if (! EQ (last_command
, this_command
))
1175 Vminibuf_scroll_window
= Qnil
;
1177 window
= Vminibuf_scroll_window
;
1178 /* If there's a fresh completion window with a live buffer,
1179 and this command is repeated, scroll that window. */
1180 if (! NILP (window
) && ! NILP (XWINDOW (window
)->buffer
)
1181 && !NILP (XBUFFER (XWINDOW (window
)->buffer
)->name
))
1183 struct buffer
*obuf
= current_buffer
;
1185 Fset_buffer (XWINDOW (window
)->buffer
);
1186 tem
= Fpos_visible_in_window_p (make_number (ZV
), window
);
1188 /* If end is in view, scroll up to the beginning. */
1189 Fset_window_start (window
, BEGV
, Qnil
);
1191 /* Else scroll down one screen. */
1192 Fscroll_other_window (Qnil
);
1194 set_buffer_internal (obuf
);
1198 i
= do_completion ();
1205 temp_echo_area_glyphs (" [Sole completion]");
1209 temp_echo_area_glyphs (" [Complete, but not unique]");
1216 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit
,
1217 Sminibuffer_complete_and_exit
, 0, 0, "",
1218 "Complete the minibuffer contents, and maybe exit.\n\
1219 Exit if the name is valid with no completion needed.\n\
1220 If name was completed to a valid match,\n\
1221 a repetition of this command will exit.")
1226 /* Allow user to specify null string */
1230 i
= do_completion ();
1238 if (!NILP (Vminibuffer_completion_confirm
))
1240 temp_echo_area_glyphs (" [Confirm]");
1250 Fthrow (Qexit
, Qnil
);
1254 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word
, Sminibuffer_complete_word
,
1256 "Complete the minibuffer contents at most a single word.\n\
1257 After one word is completed as much as possible, a space or hyphen\n\
1258 is added, provided that matches some possible completion.\n\
1259 Return nil if there is no valid completion, else t.")
1262 Lisp_Object completion
, tem
;
1264 register unsigned char *completion_string
;
1265 struct gcpro gcpro1
, gcpro2
;
1267 /* We keep calling Fbuffer_string rather than arrange for GC to
1268 hold onto a pointer to one of the strings thus made. */
1270 completion
= Ftry_completion (Fbuffer_string (),
1271 Vminibuffer_completion_table
,
1272 Vminibuffer_completion_predicate
);
1273 if (NILP (completion
))
1276 temp_echo_area_glyphs (" [No match]");
1279 if (EQ (completion
, Qt
))
1282 #if 0 /* How the below code used to look, for reference. */
1283 tem
= Fbuffer_string ();
1284 b
= XSTRING (tem
)->data
;
1285 i
= ZV
- 1 - XSTRING (completion
)->size
;
1286 p
= XSTRING (completion
)->data
;
1288 0 <= scmp (b
, p
, ZV
- 1))
1291 /* Set buffer to longest match of buffer tail and completion head. */
1292 while (0 <= scmp (b
+ i
, p
, ZV
- 1 - i
))
1294 del_range (1, i
+ 1);
1297 #else /* Rewritten code */
1299 register unsigned char *buffer_string
;
1300 int buffer_length
, completion_length
;
1302 tem
= Fbuffer_string ();
1303 GCPRO2 (completion
, tem
);
1304 /* If reading a file name,
1305 expand any $ENVVAR refs in the buffer and in TEM. */
1306 if (EQ (Vminibuffer_completion_table
, Qread_file_name_internal
))
1308 Lisp_Object substituted
;
1309 substituted
= Fsubstitute_in_file_name (tem
);
1310 if (! EQ (substituted
, tem
))
1314 insert_from_string (tem
, 0, XSTRING (tem
)->size
, 0);
1317 buffer_string
= XSTRING (tem
)->data
;
1318 completion_string
= XSTRING (completion
)->data
;
1319 buffer_length
= XSTRING (tem
)->size
; /* ie ZV - BEGV */
1320 completion_length
= XSTRING (completion
)->size
;
1321 i
= buffer_length
- completion_length
;
1322 /* Mly: I don't understand what this is supposed to do AT ALL */
1324 0 <= scmp (buffer_string
, completion_string
, buffer_length
))
1326 /* Set buffer to longest match of buffer tail and completion head. */
1330 while (0 <= scmp (buffer_string
++, completion_string
, buffer_length
--))
1332 del_range (1, i
+ 1);
1337 #endif /* Rewritten code */
1340 /* If completion finds next char not unique,
1341 consider adding a space or a hyphen. */
1342 if (i
== XSTRING (completion
)->size
)
1344 GCPRO1 (completion
);
1345 tem
= Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1346 Vminibuffer_completion_table
,
1347 Vminibuffer_completion_predicate
);
1350 if (XTYPE (tem
) == Lisp_String
)
1354 GCPRO1 (completion
);
1356 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1357 Vminibuffer_completion_table
,
1358 Vminibuffer_completion_predicate
);
1361 if (XTYPE (tem
) == Lisp_String
)
1366 /* Now find first word-break in the stuff found by completion.
1367 i gets index in string of where to stop completing. */
1369 completion_string
= XSTRING (completion
)->data
;
1371 for (; i
< XSTRING (completion
)->size
; i
++)
1372 if (SYNTAX (completion_string
[i
]) != Sword
) break;
1373 if (i
< XSTRING (completion
)->size
)
1376 /* If got no characters, print help for user. */
1381 Fminibuffer_completion_help ();
1385 /* Otherwise insert in minibuffer the chars we got */
1388 insert_from_string (completion
, 0, i
, 1);
1392 DEFUN ("display-completion-list", Fdisplay_completion_list
, Sdisplay_completion_list
,
1394 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1395 Each element may be just a symbol or string\n\
1396 or may be a list of two strings to be printed as if concatenated.\n\
1397 `standard-output' must be a buffer.\n\
1398 At the end, run the normal hook `completion-setup-hook'.\n\
1399 It can find the completion buffer in `standard-output'.")
1401 Lisp_Object completions
;
1403 register Lisp_Object tail
, elt
;
1406 struct gcpro gcpro1
;
1407 struct buffer
*old
= current_buffer
;
1409 /* Note that (when it matters) every variable
1410 points to a non-string that is pointed to by COMPLETIONS. */
1411 GCPRO1 (completions
);
1413 if (XTYPE (Vstandard_output
) == Lisp_Buffer
)
1414 set_buffer_internal (XBUFFER (Vstandard_output
));
1416 if (NILP (completions
))
1417 write_string ("There are no possible completions of what you have typed.",
1421 write_string ("Possible completions are:", -1);
1422 for (tail
= completions
, i
= 0; !NILP (tail
); tail
= Fcdr (tail
), i
++)
1424 /* this needs fixing for the case of long completions
1425 and/or narrow windows */
1426 /* Sadly, the window it will appear in is not known
1427 until after the text has been made. */
1430 if (XTYPE (Vstandard_output
) == Lisp_Buffer
)
1431 Findent_to (make_number (35), make_number (2));
1436 write_string (" ", -1);
1439 while (column
< 35);
1450 if (XTYPE (Vstandard_output
) != Lisp_Buffer
)
1453 tem
= Flength (Fcar (elt
));
1454 column
+= XINT (tem
);
1455 tem
= Flength (Fcar (Fcdr (elt
)));
1456 column
+= XINT (tem
);
1458 Fprinc (Fcar (elt
), Qnil
);
1459 Fprinc (Fcar (Fcdr (elt
)), Qnil
);
1463 if (XTYPE (Vstandard_output
) != Lisp_Buffer
)
1466 tem
= Flength (elt
);
1467 column
+= XINT (tem
);
1476 if (XTYPE (Vstandard_output
) == Lisp_Buffer
)
1477 set_buffer_internal (old
);
1479 if (!NILP (Vrun_hooks
))
1480 call1 (Vrun_hooks
, intern ("completion-setup-hook"));
1485 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help
, Sminibuffer_completion_help
,
1487 "Display a list of possible completions of the current minibuffer contents.")
1490 Lisp_Object completions
;
1492 message ("Making completion list...");
1493 completions
= Fall_completions (Fbuffer_string (),
1494 Vminibuffer_completion_table
,
1495 Vminibuffer_completion_predicate
);
1496 echo_area_glyphs
= 0;
1498 if (NILP (completions
))
1501 temp_echo_area_glyphs (" [No completions]");
1504 internal_with_output_to_temp_buffer ("*Completions*",
1505 Fdisplay_completion_list
,
1506 Fsort (completions
, Qstring_lessp
));
1510 DEFUN ("self-insert-and-exit", Fself_insert_and_exit
, Sself_insert_and_exit
, 0, 0, "",
1511 "Terminate minibuffer input.")
1514 if (XTYPE (last_command_char
) == Lisp_Int
)
1515 internal_self_insert (last_command_char
, 0);
1519 Fthrow (Qexit
, Qnil
);
1522 DEFUN ("exit-minibuffer", Fexit_minibuffer
, Sexit_minibuffer
, 0, 0, "",
1523 "Terminate this minibuffer argument.")
1526 Fthrow (Qexit
, Qnil
);
1529 DEFUN ("minibuffer-depth", Fminibuffer_depth
, Sminibuffer_depth
, 0, 0, 0,
1530 "Return current depth of activations of minibuffer, a nonnegative integer.")
1533 return make_number (minibuf_level
);
1536 DEFUN ("minibuffer-prompt", Fminibuffer_prompt
, Sminibuffer_prompt
, 0, 0, 0,
1537 "Return the prompt string of the currently-active minibuffer.\n\
1538 If no minibuffer is active, return nil.")
1541 return Fcopy_sequence (minibuf_prompt
);
1544 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width
,
1545 Sminibuffer_prompt_width
, 0, 0, 0,
1546 "Return the display width of the minibuffer prompt.")
1550 XFASTINT (width
) = minibuf_prompt_width
;
1554 init_minibuf_once ()
1556 Vminibuffer_list
= Qnil
;
1557 staticpro (&Vminibuffer_list
);
1563 minibuf_prompt
= Qnil
;
1564 staticpro (&minibuf_prompt
);
1566 minibuf_save_list
= Qnil
;
1567 staticpro (&minibuf_save_list
);
1569 Qread_file_name_internal
= intern ("read-file-name-internal");
1570 staticpro (&Qread_file_name_internal
);
1572 Qminibuffer_completion_table
= intern ("minibuffer-completion-table");
1573 staticpro (&Qminibuffer_completion_table
);
1575 Qminibuffer_completion_confirm
= intern ("minibuffer-completion-confirm");
1576 staticpro (&Qminibuffer_completion_confirm
);
1578 Qminibuffer_completion_predicate
= intern ("minibuffer-completion-predicate");
1579 staticpro (&Qminibuffer_completion_predicate
);
1581 staticpro (&last_exact_completion
);
1582 last_exact_completion
= Qnil
;
1584 staticpro (&last_minibuf_string
);
1585 last_minibuf_string
= Qnil
;
1587 Quser_variable_p
= intern ("user-variable-p");
1588 staticpro (&Quser_variable_p
);
1590 Qminibuffer_history
= intern ("minibuffer-history");
1591 staticpro (&Qminibuffer_history
);
1593 Qminibuffer_setup_hook
= intern ("minibuffer-setup-hook");
1594 staticpro (&Qminibuffer_setup_hook
);
1596 Qminibuffer_exit_hook
= intern ("minibuffer-exit-hook");
1597 staticpro (&Qminibuffer_exit_hook
);
1599 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook
,
1600 "Normal hook run just after entry to minibuffer.");
1601 Vminibuffer_setup_hook
= Qnil
;
1603 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook
,
1604 "Normal hook run just after exit from minibuffer.");
1605 Vminibuffer_exit_hook
= Qnil
;
1607 DEFVAR_BOOL ("completion-auto-help", &auto_help
,
1608 "*Non-nil means automatically provide help for invalid completion input.");
1611 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case
,
1612 "Non-nil means don't consider case significant in completion.");
1613 completion_ignore_case
= 0;
1615 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers
,
1616 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
1617 More precisely, this variable makes a difference when the minibuffer window\n\
1618 is the selected window. If you are in some other window, minibuffer commands\n\
1619 are allowed even if a minibuffer is active.");
1620 enable_recursive_minibuffers
= 0;
1622 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table
,
1623 "Alist or obarray used for completion in the minibuffer.\n\
1624 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
1626 The value may alternatively be a function, which is given three arguments:\n\
1627 STRING, the current buffer contents;\n\
1628 PREDICATE, the predicate for filtering possible matches;\n\
1629 CODE, which says what kind of things to do.\n\
1630 CODE can be nil, t or `lambda'.\n\
1631 nil means to return the best completion of STRING, or nil if there is none.\n\
1632 t means to return a list of all possible completions of STRING.\n\
1633 `lambda' means to return t if STRING is a valid completion as it stands.");
1634 Vminibuffer_completion_table
= Qnil
;
1636 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate
,
1637 "Within call to `completing-read', this holds the PREDICATE argument.");
1638 Vminibuffer_completion_predicate
= Qnil
;
1640 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm
,
1641 "Non-nil => demand confirmation of completion before exiting minibuffer.");
1642 Vminibuffer_completion_confirm
= Qnil
;
1644 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form
,
1645 "Value that `help-form' takes on inside the minibuffer.");
1646 Vminibuffer_help_form
= Qnil
;
1648 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable
,
1649 "History list symbol to add minibuffer values to.\n\
1650 Each minibuffer output is added with\n\
1651 (set minibuffer-history-variable\n\
1652 (cons STRING (symbol-value minibuffer-history-variable)))");
1653 XFASTINT (Vminibuffer_history_variable
) = 0;
1655 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position
,
1656 "Current position of redoing in the history list.");
1657 Vminibuffer_history_position
= Qnil
;
1659 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise
,
1660 "*Non-nil means entering the minibuffer raises the minibuffer's frame.");
1661 minibuffer_auto_raise
= 0;
1663 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list
,
1664 "List of regexps that should restrict possible completions.");
1665 Vcompletion_regexp_list
= Qnil
;
1667 defsubr (&Sread_from_minibuffer
);
1668 defsubr (&Seval_minibuffer
);
1669 defsubr (&Sread_minibuffer
);
1670 defsubr (&Sread_string
);
1671 defsubr (&Sread_command
);
1672 defsubr (&Sread_variable
);
1673 defsubr (&Sread_buffer
);
1674 defsubr (&Sread_no_blanks_input
);
1675 defsubr (&Sminibuffer_depth
);
1676 defsubr (&Sminibuffer_prompt
);
1677 defsubr (&Sminibuffer_prompt_width
);
1679 defsubr (&Stry_completion
);
1680 defsubr (&Sall_completions
);
1681 defsubr (&Scompleting_read
);
1682 defsubr (&Sminibuffer_complete
);
1683 defsubr (&Sminibuffer_complete_word
);
1684 defsubr (&Sminibuffer_complete_and_exit
);
1685 defsubr (&Sdisplay_completion_list
);
1686 defsubr (&Sminibuffer_completion_help
);
1688 defsubr (&Sself_insert_and_exit
);
1689 defsubr (&Sexit_minibuffer
);
1695 initial_define_key (Vminibuffer_local_map
, Ctl ('g'),
1696 "abort-recursive-edit");
1697 initial_define_key (Vminibuffer_local_map
, Ctl ('m'),
1699 initial_define_key (Vminibuffer_local_map
, Ctl ('j'),
1702 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('g'),
1703 "abort-recursive-edit");
1704 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('m'),
1706 initial_define_key (Vminibuffer_local_ns_map
, Ctl ('j'),
1709 initial_define_key (Vminibuffer_local_ns_map
, ' ',
1711 initial_define_key (Vminibuffer_local_ns_map
, '\t',
1713 initial_define_key (Vminibuffer_local_ns_map
, '?',
1714 "self-insert-and-exit");
1716 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('g'),
1717 "abort-recursive-edit");
1718 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('m'),
1720 initial_define_key (Vminibuffer_local_completion_map
, Ctl ('j'),
1723 initial_define_key (Vminibuffer_local_completion_map
, '\t',
1724 "minibuffer-complete");
1725 initial_define_key (Vminibuffer_local_completion_map
, ' ',
1726 "minibuffer-complete-word");
1727 initial_define_key (Vminibuffer_local_completion_map
, '?',
1728 "minibuffer-completion-help");
1730 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('g'),
1731 "abort-recursive-edit");
1732 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('m'),
1733 "minibuffer-complete-and-exit");
1734 initial_define_key (Vminibuffer_local_must_match_map
, Ctl ('j'),
1735 "minibuffer-complete-and-exit");
1736 initial_define_key (Vminibuffer_local_must_match_map
, '\t',
1737 "minibuffer-complete");
1738 initial_define_key (Vminibuffer_local_must_match_map
, ' ',
1739 "minibuffer-complete-word");
1740 initial_define_key (Vminibuffer_local_must_match_map
, '?',
1741 "minibuffer-completion-help");