.
[emacs.git] / src / minibuf.c
blob033c598e0a19dbf0ae6c2725e659716bd4c70d75
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998
3 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include <config.h>
24 #include <stdio.h>
25 #include "lisp.h"
26 #include "commands.h"
27 #include "buffer.h"
28 #include "charset.h"
29 #include "dispextern.h"
30 #include "frame.h"
31 #include "window.h"
32 #include "syntax.h"
33 #include "keyboard.h"
35 #define min(a, b) ((a) < (b) ? (a) : (b))
37 extern int quit_char;
39 /* List of buffers for use as minibuffers.
40 The first element of the list is used for the outermost minibuffer
41 invocation, the next element is used for a recursive minibuffer
42 invocation, etc. The list is extended at the end as deeper
43 minibuffer recursions are encountered. */
45 Lisp_Object Vminibuffer_list;
47 /* Data to remember during recursive minibuffer invocations */
49 Lisp_Object minibuf_save_list;
51 /* Depth in minibuffer invocations. */
53 int minibuf_level;
55 /* Nonzero means display completion help for invalid input. */
57 int auto_help;
59 /* The maximum length of a minibuffer history. */
61 Lisp_Object Qhistory_length, Vhistory_length;
63 /* Fread_minibuffer leaves the input here as a string. */
65 Lisp_Object last_minibuf_string;
67 /* Nonzero means let functions called when within a minibuffer
68 invoke recursive minibuffers (to read arguments, or whatever) */
70 int enable_recursive_minibuffers;
72 /* Nonzero means don't ignore text properties
73 in Fread_from_minibuffer. */
75 int minibuffer_allow_text_properties;
77 /* help-form is bound to this while in the minibuffer. */
79 Lisp_Object Vminibuffer_help_form;
81 /* Variable which is the history list to add minibuffer values to. */
83 Lisp_Object Vminibuffer_history_variable;
85 /* Current position in the history list (adjusted by M-n and M-p). */
87 Lisp_Object Vminibuffer_history_position;
89 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
91 Lisp_Object Qread_file_name_internal;
93 /* Normal hooks for entry to and exit from minibuffer. */
95 Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
96 Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
98 /* Function to call to read a buffer name. */
99 Lisp_Object Vread_buffer_function;
101 /* Nonzero means completion ignores case. */
103 int completion_ignore_case;
105 /* List of regexps that should restrict possible completions. */
107 Lisp_Object Vcompletion_regexp_list;
109 /* Nonzero means raise the minibuffer frame when the minibuffer
110 is entered. */
112 int minibuffer_auto_raise;
114 /* If last completion attempt reported "Complete but not unique"
115 then this is the string completed then; otherwise this is nil. */
117 static Lisp_Object last_exact_completion;
119 /* Non-nil means it is the window for C-M-v to scroll
120 when the minibuffer is selected. */
122 extern Lisp_Object Vminibuf_scroll_window;
124 extern Lisp_Object Voverriding_local_map;
126 Lisp_Object Quser_variable_p;
128 Lisp_Object Qminibuffer_default;
130 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
132 extern Lisp_Object Qmouse_face;
135 /* Put minibuf on currently selected frame's minibuffer.
136 We do this whenever the user starts a new minibuffer
137 or when a minibuffer exits. */
139 void
140 choose_minibuf_frame ()
142 if (FRAMEP (selected_frame)
143 && FRAME_LIVE_P (XFRAME (selected_frame))
144 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
146 struct frame *sf = XFRAME (selected_frame);
147 Lisp_Object buffer;
149 /* I don't think that any frames may validly have a null minibuffer
150 window anymore. */
151 if (NILP (sf->minibuffer_window))
152 abort ();
154 /* Under X, we come here with minibuf_window being the
155 minibuffer window of the unused termcap window created in
156 init_window_once. That window doesn't have a buffer. */
157 buffer = XWINDOW (minibuf_window)->buffer;
158 if (BUFFERP (buffer))
159 Fset_window_buffer (sf->minibuffer_window, buffer);
160 minibuf_window = sf->minibuffer_window;
163 /* Make sure no other frame has a minibuffer as its selected window,
164 because the text would not be displayed in it, and that would be
165 confusing. Only allow the selected frame to do this,
166 and that only if the minibuffer is active. */
168 Lisp_Object tail, frame;
170 FOR_EACH_FRAME (tail, frame)
171 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
172 && !(EQ (frame, selected_frame)
173 && minibuf_level > 0))
174 Fset_frame_selected_window (frame, Fframe_first_window (frame));
178 Lisp_Object
179 choose_minibuf_frame_1 (ignore)
180 Lisp_Object ignore;
182 choose_minibuf_frame ();
183 return Qnil;
186 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
187 Sset_minibuffer_window, 1, 1, 0,
188 "Specify which minibuffer window to use for the minibuffer.\n\
189 This effects where the minibuffer is displayed if you put text in it\n\
190 without invoking the usual minibuffer commands.")
191 (window)
192 Lisp_Object window;
194 CHECK_WINDOW (window, 1);
195 if (! MINI_WINDOW_P (XWINDOW (window)))
196 error ("Window is not a minibuffer window");
198 minibuf_window = window;
200 return window;
204 /* Actual minibuffer invocation. */
206 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
207 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
208 Lisp_Object, Lisp_Object,
209 int, Lisp_Object,
210 Lisp_Object, Lisp_Object,
211 int, int));
213 /* Read from the minibuffer using keymap MAP, initial contents INITIAL
214 (a string), putting point minus BACKUP_N bytes from the end of INITIAL,
215 prompting with PROMPT (a string), using history list HISTVAR
216 with initial position HISTPOS. (BACKUP_N should be <= 0.)
218 Normally return the result as a string (the text that was read),
219 but if EXPFLAG is nonzero, read it and return the object read.
220 If HISTVAR is given, save the value read on that history only if it doesn't
221 match the front of that history list exactly. The value is pushed onto
222 the list as the string that was read.
224 DEFALT specifies te default value for the sake of history commands.
226 If ALLOW_PROPS is nonzero, we do not throw away text properties.
228 if INHERIT_INPUT_METHOD is nonzeor, the minibuffer inherit the
229 current input method. */
231 static Lisp_Object
232 read_minibuf (map, initial, prompt, backup_n, expflag,
233 histvar, histpos, defalt, allow_props, inherit_input_method)
234 Lisp_Object map;
235 Lisp_Object initial;
236 Lisp_Object prompt;
237 Lisp_Object backup_n;
238 int expflag;
239 Lisp_Object histvar;
240 Lisp_Object histpos;
241 Lisp_Object defalt;
242 int allow_props;
243 int inherit_input_method;
245 Lisp_Object val;
246 int count = specpdl_ptr - specpdl;
247 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
248 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
249 Lisp_Object enable_multibyte;
250 extern Lisp_Object Qread_only, Qfront_sticky;
251 extern Lisp_Object Qrear_nonsticky;
253 specbind (Qminibuffer_default, defalt);
255 single_kboard_state ();
257 val = Qnil;
258 ambient_dir = current_buffer->directory;
259 input_method = Qnil;
260 enable_multibyte = Qnil;
262 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
263 store them away before we can GC. Don't need to protect
264 BACKUP_N because we use the value only if it is an integer. */
265 GCPRO5 (map, initial, val, ambient_dir, input_method);
267 if (!STRINGP (prompt))
268 prompt = build_string ("");
270 if (!enable_recursive_minibuffers
271 && minibuf_level > 0)
273 if (EQ (selected_window, minibuf_window))
274 error ("Command attempted to use minibuffer while in minibuffer");
275 else
276 /* If we're in another window, cancel the minibuffer that's active. */
277 Fthrow (Qexit,
278 build_string ("Command attempted to use minibuffer while in minibuffer"));
281 /* Choose the minibuffer window and frame, and take action on them. */
283 choose_minibuf_frame ();
285 record_unwind_protect (choose_minibuf_frame_1, Qnil);
287 record_unwind_protect (Fset_window_configuration,
288 Fcurrent_window_configuration (Qnil));
290 /* If the minibuffer window is on a different frame, save that
291 frame's configuration too. */
292 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
293 if (!EQ (mini_frame, selected_frame))
294 record_unwind_protect (Fset_window_configuration,
295 Fcurrent_window_configuration (mini_frame));
297 /* If the minibuffer is on an iconified or invisible frame,
298 make it visible now. */
299 Fmake_frame_visible (mini_frame);
301 if (minibuffer_auto_raise)
302 Fraise_frame (mini_frame);
304 /* We have to do this after saving the window configuration
305 since that is what restores the current buffer. */
307 /* Arrange to restore a number of minibuffer-related variables.
308 We could bind each variable separately, but that would use lots of
309 specpdl slots. */
310 minibuf_save_list
311 = Fcons (Voverriding_local_map,
312 Fcons (minibuf_window, minibuf_save_list));
313 minibuf_save_list
314 = Fcons (minibuf_prompt,
315 Fcons (make_number (minibuf_prompt_width),
316 Fcons (Vhelp_form,
317 Fcons (Vcurrent_prefix_arg,
318 Fcons (Vminibuffer_history_position,
319 Fcons (Vminibuffer_history_variable,
320 minibuf_save_list))))));
321 minibuf_save_list
322 = Fcons (current_buffer->prompt_end_charpos,
323 minibuf_save_list);
325 record_unwind_protect (read_minibuf_unwind, Qnil);
326 minibuf_level++;
328 /* Now that we can restore all those variables, start changing them. */
330 minibuf_prompt_width = 0;
331 minibuf_prompt = Fcopy_sequence (prompt);
332 Vminibuffer_history_position = histpos;
333 Vminibuffer_history_variable = histvar;
334 Vhelp_form = Vminibuffer_help_form;
336 if (inherit_input_method)
338 /* `current-input-method' is buffer local. So, remeber it in
339 INPUT_METHOD before changing the current buffer. */
340 input_method = Fsymbol_value (Qcurrent_input_method);
341 enable_multibyte = current_buffer->enable_multibyte_characters;
344 /* Switch to the minibuffer. */
346 minibuffer = get_minibuffer (minibuf_level);
347 Fset_buffer (minibuffer);
349 /* The current buffer's default directory is usually the right thing
350 for our minibuffer here. However, if you're typing a command at
351 a minibuffer-only frame when minibuf_level is zero, then buf IS
352 the current_buffer, so reset_buffer leaves buf's default
353 directory unchanged. This is a bummer when you've just started
354 up Emacs and buf's default directory is Qnil. Here's a hack; can
355 you think of something better to do? Find another buffer with a
356 better directory, and use that one instead. */
357 if (STRINGP (ambient_dir))
358 current_buffer->directory = ambient_dir;
359 else
361 Lisp_Object buf_list;
363 for (buf_list = Vbuffer_alist;
364 CONSP (buf_list);
365 buf_list = XCONS (buf_list)->cdr)
367 Lisp_Object other_buf;
369 other_buf = XCONS (XCONS (buf_list)->car)->cdr;
370 if (STRINGP (XBUFFER (other_buf)->directory))
372 current_buffer->directory = XBUFFER (other_buf)->directory;
373 break;
378 if (!EQ (mini_frame, selected_frame))
379 Fredirect_frame_focus (selected_frame, mini_frame);
381 Vminibuf_scroll_window = selected_window;
382 Fset_window_buffer (minibuf_window, Fcurrent_buffer ());
383 Fselect_window (minibuf_window);
384 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
386 Fmake_local_variable (Qprint_escape_newlines);
387 print_escape_newlines = 1;
388 XSETFASTINT (current_buffer->prompt_end_charpos, 0);
390 /* Erase the buffer. */
392 int count1 = specpdl_ptr - specpdl;
393 specbind (Qinhibit_read_only, Qt);
394 Ferase_buffer ();
395 unbind_to (count1, Qnil);
398 if (!NILP (current_buffer->enable_multibyte_characters)
399 && ! STRING_MULTIBYTE (minibuf_prompt))
400 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
402 /* Insert the prompt, record where it ends. */
403 Finsert (1, &minibuf_prompt);
404 XSETFASTINT (current_buffer->prompt_end_charpos, PT);
405 if (PT > BEG)
407 Fput_text_property (make_number (BEG), make_number (PT),
408 Qfront_sticky, Qt, Qnil);
409 Fput_text_property (make_number (BEG), make_number (PT),
410 Qrear_nonsticky, Qt, Qnil);
411 Fput_text_property (make_number (BEG), make_number (PT),
412 Qread_only, Qt, Qnil);
415 minibuf_prompt_width = current_column ();
417 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
418 if (inherit_input_method)
419 current_buffer->enable_multibyte_characters = enable_multibyte;
421 /* Put in the initial input. */
422 if (!NILP (initial))
424 Finsert (1, &initial);
425 if (INTEGERP (backup_n))
426 Fforward_char (backup_n);
429 clear_message (1, 1);
430 current_buffer->keymap = map;
432 /* Turn on an input method stored in INPUT_METHOD if any. */
433 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
434 call1 (Qactivate_input_method, input_method);
436 /* Run our hook, but not if it is empty.
437 (run-hooks would do nothing if it is empty,
438 but it's important to save time here in the usual case). */
439 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
440 && !NILP (Vrun_hooks))
441 call1 (Vrun_hooks, Qminibuffer_setup_hook);
443 recursive_edit_1 ();
445 /* If cursor is on the minibuffer line,
446 show the user we have exited by putting it in column 0. */
447 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
448 && !noninteractive)
450 XWINDOW (minibuf_window)->cursor.hpos = 0;
451 XWINDOW (minibuf_window)->cursor.x = 0;
452 XWINDOW (minibuf_window)->must_be_updated_p = 1;
453 update_frame (XFRAME (selected_frame), 1, 1);
454 if (rif && rif->flush_display)
455 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
458 /* Make minibuffer contents into a string. */
459 Fset_buffer (minibuffer);
460 val = make_buffer_string (current_buffer->prompt_end_charpos,
461 Z, allow_props);
463 /* VAL is the string of minibuffer text. */
465 last_minibuf_string = val;
467 /* Add the value to the appropriate history list unless it is empty. */
468 if (XSTRING (val)->size != 0
469 && SYMBOLP (Vminibuffer_history_variable))
471 /* If the caller wanted to save the value read on a history list,
472 then do so if the value is not already the front of the list. */
473 Lisp_Object histval;
475 /* If variable is unbound, make it nil. */
476 if (EQ (XSYMBOL (Vminibuffer_history_variable)->value, Qunbound))
477 Fset (Vminibuffer_history_variable, Qnil);
479 histval = Fsymbol_value (Vminibuffer_history_variable);
481 /* The value of the history variable must be a cons or nil. Other
482 values are unacceptable. We silently ignore these values. */
483 if (NILP (histval)
484 || (CONSP (histval)
485 && NILP (Fequal (last_minibuf_string, Fcar (histval)))))
487 Lisp_Object length;
489 histval = Fcons (last_minibuf_string, histval);
490 Fset (Vminibuffer_history_variable, histval);
492 /* Truncate if requested. */
493 length = Fget (Vminibuffer_history_variable, Qhistory_length);
494 if (NILP (length)) length = Vhistory_length;
495 if (INTEGERP (length))
497 if (XINT (length) <= 0)
498 Fset (Vminibuffer_history_variable, Qnil);
499 else
501 Lisp_Object temp;
503 temp = Fnthcdr (Fsub1 (length), histval);
504 if (CONSP (temp)) Fsetcdr (temp, Qnil);
510 /* If Lisp form desired instead of string, parse it. */
511 if (expflag)
513 Lisp_Object expr_and_pos;
514 int pos;
516 if (STRINGP (val) && XSTRING (val)->size == 0
517 && STRINGP (defalt))
518 val = defalt;
520 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
521 pos = XINT (Fcdr (expr_and_pos));
522 if (pos != XSTRING (val)->size)
524 /* Ignore trailing whitespace; any other trailing junk is an error. */
525 int i;
526 pos = string_char_to_byte (val, pos);
527 for (i = pos; i < STRING_BYTES (XSTRING (val)); i++)
529 int c = XSTRING (val)->data[i];
530 if (c != ' ' && c != '\t' && c != '\n')
531 error ("Trailing garbage following expression");
534 val = Fcar (expr_and_pos);
537 /* The appropriate frame will get selected
538 in set-window-configuration. */
539 RETURN_UNGCPRO (unbind_to (count, val));
542 /* Return a buffer to be used as the minibuffer at depth `depth'.
543 depth = 0 is the lowest allowed argument, and that is the value
544 used for nonrecursive minibuffer invocations */
546 Lisp_Object
547 get_minibuffer (depth)
548 int depth;
550 Lisp_Object tail, num, buf;
551 char name[24];
552 extern Lisp_Object nconc2 ();
554 XSETFASTINT (num, depth);
555 tail = Fnthcdr (num, Vminibuffer_list);
556 if (NILP (tail))
558 tail = Fcons (Qnil, Qnil);
559 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
561 buf = Fcar (tail);
562 if (NILP (buf) || NILP (XBUFFER (buf)->name))
564 sprintf (name, " *Minibuf-%d*", depth);
565 buf = Fget_buffer_create (build_string (name));
567 /* Although the buffer's name starts with a space, undo should be
568 enabled in it. */
569 Fbuffer_enable_undo (buf);
571 XCONS (tail)->car = buf;
573 else
575 int count = specpdl_ptr - specpdl;
577 reset_buffer (XBUFFER (buf));
578 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
579 Fset_buffer (buf);
580 Fkill_all_local_variables ();
581 unbind_to (count, Qnil);
584 return buf;
587 /* This function is called on exiting minibuffer, whether normally or
588 not, and it restores the current window, buffer, etc. */
590 static Lisp_Object
591 read_minibuf_unwind (data)
592 Lisp_Object data;
594 Lisp_Object old_deactivate_mark;
595 Lisp_Object window;
597 /* We are exiting the minibuffer one way or the other,
598 so run the hook. */
599 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
600 && !NILP (Vrun_hooks))
601 safe_run_hooks (Qminibuffer_exit_hook);
603 /* If this was a recursive minibuffer,
604 tie the minibuffer window back to the outer level minibuffer buffer. */
605 minibuf_level--;
607 window = minibuf_window;
608 /* To keep things predictable, in case it matters, let's be in the
609 minibuffer when we reset the relevant variables. */
610 Fset_buffer (XWINDOW (window)->buffer);
612 /* Restore prompt, etc, from outer minibuffer level. */
613 current_buffer->prompt_end_charpos = Fcar (minibuf_save_list);
614 minibuf_save_list = Fcdr (minibuf_save_list);
616 minibuf_prompt = Fcar (minibuf_save_list);
617 minibuf_save_list = Fcdr (minibuf_save_list);
618 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
619 minibuf_save_list = Fcdr (minibuf_save_list);
620 Vhelp_form = Fcar (minibuf_save_list);
621 minibuf_save_list = Fcdr (minibuf_save_list);
622 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
623 minibuf_save_list = Fcdr (minibuf_save_list);
624 Vminibuffer_history_position = Fcar (minibuf_save_list);
625 minibuf_save_list = Fcdr (minibuf_save_list);
626 Vminibuffer_history_variable = Fcar (minibuf_save_list);
627 minibuf_save_list = Fcdr (minibuf_save_list);
628 Voverriding_local_map = Fcar (minibuf_save_list);
629 minibuf_save_list = Fcdr (minibuf_save_list);
630 #if 0
631 temp = Fcar (minibuf_save_list);
632 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
633 minibuf_window = temp;
634 #endif
635 minibuf_save_list = Fcdr (minibuf_save_list);
637 /* Erase the minibuffer we were using at this level. */
639 int count = specpdl_ptr - specpdl;
640 /* Prevent error in erase-buffer. */
641 specbind (Qinhibit_read_only, Qt);
642 old_deactivate_mark = Vdeactivate_mark;
643 Ferase_buffer ();
644 Vdeactivate_mark = old_deactivate_mark;
645 unbind_to (count, Qnil);
648 /* When we get to the outmost level, make sure we resize the
649 mini-window back to its normal size. */
650 if (minibuf_level == 0)
651 resize_mini_window (XWINDOW (window), 0);
653 /* Make sure minibuffer window is erased, not ignored. */
654 windows_or_buffers_changed++;
655 XSETFASTINT (XWINDOW (window)->last_modified, 0);
656 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
657 return Qnil;
661 /* This comment supplies the doc string for read-from-minibuffer,
662 for make-docfile to see. We cannot put this in the real DEFUN
663 due to limits in the Unix cpp.
665 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
666 "Read a string from the minibuffer, prompting with string PROMPT.\n\
667 If optional second arg INITIAL-CONTENTS is non-nil, it is a string\n\
668 to be inserted into the minibuffer before reading input.\n\
669 If INITIAL-CONTENTS is (STRING . POSITION), the initial input\n\
670 is STRING, but point is placed at position POSITION in the minibuffer.\n\
671 Third arg KEYMAP is a keymap to use whilst reading;\n\
672 if omitted or nil, the default is `minibuffer-local-map'.\n\
673 If fourth arg READ is non-nil, then interpret the result as a lisp object\n\
674 and return that object:\n\
675 in other words, do `(car (read-from-string INPUT-STRING))'\n\
676 Fifth arg HIST, if non-nil, specifies a history list\n\
677 and optionally the initial position in the list.\n\
678 It can be a symbol, which is the history list variable to use,\n\
679 or it can be a cons cell (HISTVAR . HISTPOS).\n\
680 In that case, HISTVAR is the history list variable to use,\n\
681 and HISTPOS is the initial position (the position in the list\n\
682 which INITIAL-CONTENTS corresponds to).\n\
683 Positions are counted starting from 1 at the beginning of the list.\n\
684 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available\n\
685 for history commands; but `read-from-minibuffer' does NOT return DEFAULT-VALUE\n\
686 if the user enters empty input! It returns the empty string.\n\
687 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
688 the current input method and the setting of enable-multibyte-characters.\n\
689 If the variable `minibuffer-allow-text-properties' is non-nil,\n\
690 then the string which is returned includes whatever text properties\n\
691 were present in the minibuffer. Otherwise the value has no text properties.")
692 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
695 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
696 0 /* See immediately above */)
697 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
698 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
699 Lisp_Object inherit_input_method;
701 int pos = 0;
702 Lisp_Object histvar, histpos, position, val;
703 struct gcpro gcpro1;
705 position = Qnil;
707 CHECK_STRING (prompt, 0);
708 if (!NILP (initial_contents))
710 if (CONSP (initial_contents))
712 position = Fcdr (initial_contents);
713 initial_contents = Fcar (initial_contents);
715 CHECK_STRING (initial_contents, 1);
716 if (!NILP (position))
718 CHECK_NUMBER (position, 0);
719 /* Convert to distance from end of input. */
720 if (XINT (position) < 1)
721 /* A number too small means the beginning of the string. */
722 pos = - XSTRING (initial_contents)->size;
723 else
724 pos = XINT (position) - 1 - XSTRING (initial_contents)->size;
728 if (NILP (keymap))
729 keymap = Vminibuffer_local_map;
730 else
731 keymap = get_keymap (keymap);
733 if (SYMBOLP (hist))
735 histvar = hist;
736 histpos = Qnil;
738 else
740 histvar = Fcar_safe (hist);
741 histpos = Fcdr_safe (hist);
743 if (NILP (histvar))
744 histvar = Qminibuffer_history;
745 if (NILP (histpos))
746 XSETFASTINT (histpos, 0);
748 GCPRO1 (default_value);
749 val = read_minibuf (keymap, initial_contents, prompt,
750 make_number (pos), !NILP (read),
751 histvar, histpos, default_value,
752 minibuffer_allow_text_properties,
753 !NILP (inherit_input_method));
754 UNGCPRO;
755 return val;
758 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
759 "Return a Lisp object read using the minibuffer.\n\
760 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
761 is a string to insert in the minibuffer before reading.")
762 (prompt, initial_contents)
763 Lisp_Object prompt, initial_contents;
765 CHECK_STRING (prompt, 0);
766 if (!NILP (initial_contents))
767 CHECK_STRING (initial_contents, 1);
768 return read_minibuf (Vminibuffer_local_map, initial_contents,
769 prompt, Qnil, 1, Qminibuffer_history,
770 make_number (0), Qnil, 0, 0);
773 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
774 "Return value of Lisp expression read using the minibuffer.\n\
775 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS\n\
776 is a string to insert in the minibuffer before reading.")
777 (prompt, initial_contents)
778 Lisp_Object prompt, initial_contents;
780 return Feval (Fread_minibuffer (prompt, initial_contents));
783 /* Functions that use the minibuffer to read various things. */
785 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
786 "Read a string from the minibuffer, prompting with string PROMPT.\n\
787 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.\n\
788 The third arg HISTORY, if non-nil, specifies a history list\n\
789 and optionally the initial position in the list.\n\
790 See `read-from-minibuffer' for details of HISTORY argument.\n\
791 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used\n\
792 for history commands, and as the value to return if the user enters\n\
793 the empty string.\n\
794 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
795 the current input method and the setting of enable-multibyte-characters.")
796 (prompt, initial_input, history, default_value, inherit_input_method)
797 Lisp_Object prompt, initial_input, history, default_value;
798 Lisp_Object inherit_input_method;
800 Lisp_Object val;
801 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
802 Qnil, history, default_value,
803 inherit_input_method);
804 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (default_value))
805 val = default_value;
806 return val;
809 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
810 "Read a string from the terminal, not allowing blanks.\n\
811 Prompt with PROMPT, and provide INITIAL as an initial value of the input string.\n\
812 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits\n\
813 the current input method and the setting of enable-multibyte-characters.")
814 (prompt, initial, inherit_input_method)
815 Lisp_Object prompt, initial, inherit_input_method;
817 CHECK_STRING (prompt, 0);
818 if (! NILP (initial))
819 CHECK_STRING (initial, 1);
821 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
822 0, Qminibuffer_history, make_number (0), Qnil, 0,
823 !NILP (inherit_input_method));
826 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
827 "Read the name of a command and return as a symbol.\n\
828 Prompts with PROMPT. By default, return DEFAULT-VALUE.")
829 (prompt, default_value)
830 Lisp_Object prompt, default_value;
832 Lisp_Object name, default_string;
834 if (NILP (default_value))
835 default_string = Qnil;
836 else if (SYMBOLP (default_value))
837 XSETSTRING (default_string, XSYMBOL (default_value)->name);
838 else
839 default_string = default_value;
841 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
842 Qnil, Qnil, default_string, Qnil);
843 if (NILP (name))
844 return name;
845 return Fintern (name, Qnil);
848 #ifdef NOTDEF
849 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
850 "One arg PROMPT, a string. Read the name of a function and return as a symbol.\n\
851 Prompts with PROMPT.")
852 (prompt)
853 Lisp_Object prompt;
855 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
856 Qnil);
858 #endif /* NOTDEF */
860 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
861 "Read the name of a user variable and return it as a symbol.\n\
862 Prompts with PROMPT. By default, return DEFAULT-VALUE.\n\
863 A user variable is one whose documentation starts with a `*' character.")
864 (prompt, default_value)
865 Lisp_Object prompt, default_value;
867 Lisp_Object name, default_string;
869 if (NILP (default_value))
870 default_string = Qnil;
871 else if (SYMBOLP (default_value))
872 XSETSTRING (default_string, XSYMBOL (default_value)->name);
873 else
874 default_string = default_value;
876 name = Fcompleting_read (prompt, Vobarray,
877 Quser_variable_p, Qt,
878 Qnil, Qnil, default_string, Qnil);
879 if (NILP (name))
880 return name;
881 return Fintern (name, Qnil);
884 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
885 "One arg PROMPT, a string. Read the name of a buffer and return as a string.\n\
886 Prompts with PROMPT.\n\
887 Optional second arg DEF is value to return if user enters an empty line.\n\
888 If optional third arg REQUIRE-MATCH is non-nil, only existing buffer names are allowed.")
889 (prompt, def, require_match)
890 Lisp_Object prompt, def, require_match;
892 Lisp_Object args[4];
894 if (BUFFERP (def))
895 def = XBUFFER (def)->name;
897 if (NILP (Vread_buffer_function))
899 if (!NILP (def))
901 args[0] = build_string ("%s(default %s) ");
902 args[1] = prompt;
903 args[2] = def;
904 prompt = Fformat (3, args);
907 return Fcompleting_read (prompt, Vbuffer_alist, Qnil,
908 require_match, Qnil, Qbuffer_name_history,
909 def, Qnil);
911 else
913 args[0] = Vread_buffer_function;
914 args[1] = prompt;
915 args[2] = def;
916 args[3] = require_match;
917 return Ffuncall(4, args);
921 static Lisp_Object
922 minibuf_conform_representation (string, basis)
923 Lisp_Object string, basis;
925 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
926 return string;
928 if (STRING_MULTIBYTE (string))
929 return Fstring_make_unibyte (string);
930 else
931 return Fstring_make_multibyte (string);
934 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
935 "Return common substring of all completions of STRING in ALIST.\n\
936 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
937 All that match are compared together; the longest initial sequence\n\
938 common to all matches is returned as a string.\n\
939 If there is no match at all, nil is returned.\n\
940 For an exact match, t is returned.\n\
942 ALIST can be an obarray instead of an alist.\n\
943 Then the print names of all symbols in the obarray are the possible matches.\n\
945 ALIST can also be a function to do the completion itself.\n\
946 It receives three arguments: the values STRING, PREDICATE and nil.\n\
947 Whatever it returns becomes the value of `try-completion'.\n\
949 If optional third argument PREDICATE is non-nil,\n\
950 it is used to test each possible match.\n\
951 The match is a candidate only if PREDICATE returns non-nil.\n\
952 The argument given to PREDICATE is the alist element\n\
953 or the symbol from the obarray.")
954 (string, alist, predicate)
955 Lisp_Object string, alist, predicate;
957 Lisp_Object bestmatch, tail, elt, eltstring;
958 /* Size in bytes of BESTMATCH. */
959 int bestmatchsize;
960 /* These are in bytes, too. */
961 int compare, matchsize;
962 int list = CONSP (alist) || NILP (alist);
963 int index, obsize;
964 int matchcount = 0;
965 Lisp_Object bucket, zero, end, tem;
966 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
968 CHECK_STRING (string, 0);
969 if (!list && !VECTORP (alist))
970 return call3 (alist, string, predicate, Qnil);
972 bestmatch = Qnil;
974 /* If ALIST is not a list, set TAIL just for gc pro. */
975 tail = alist;
976 if (! list)
978 index = 0;
979 obsize = XVECTOR (alist)->size;
980 bucket = XVECTOR (alist)->contents[index];
983 while (1)
985 /* Get the next element of the alist or obarray. */
986 /* Exit the loop if the elements are all used up. */
987 /* elt gets the alist element or symbol.
988 eltstring gets the name to check as a completion. */
990 if (list)
992 if (NILP (tail))
993 break;
994 elt = Fcar (tail);
995 eltstring = Fcar (elt);
996 tail = Fcdr (tail);
998 else
1000 if (XFASTINT (bucket) != 0)
1002 elt = bucket;
1003 eltstring = Fsymbol_name (elt);
1004 if (XSYMBOL (bucket)->next)
1005 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1006 else
1007 XSETFASTINT (bucket, 0);
1009 else if (++index >= obsize)
1010 break;
1011 else
1013 bucket = XVECTOR (alist)->contents[index];
1014 continue;
1018 /* Is this element a possible completion? */
1020 if (STRINGP (eltstring)
1021 && XSTRING (string)->size <= XSTRING (eltstring)->size
1022 && (tem = Fcompare_strings (eltstring, make_number (0),
1023 make_number (XSTRING (string)->size),
1024 string, make_number (0), Qnil,
1025 completion_ignore_case ?Qt : Qnil),
1026 EQ (Qt, tem)))
1028 /* Yes. */
1029 Lisp_Object regexps;
1030 Lisp_Object zero;
1031 XSETFASTINT (zero, 0);
1033 /* Ignore this element if it fails to match all the regexps. */
1034 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1035 regexps = XCONS (regexps)->cdr)
1037 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
1038 if (NILP (tem))
1039 break;
1041 if (CONSP (regexps))
1042 continue;
1044 /* Ignore this element if there is a predicate
1045 and the predicate doesn't like it. */
1047 if (!NILP (predicate))
1049 if (EQ (predicate, Qcommandp))
1050 tem = Fcommandp (elt);
1051 else
1053 GCPRO4 (tail, string, eltstring, bestmatch);
1054 tem = call1 (predicate, elt);
1055 UNGCPRO;
1057 if (NILP (tem)) continue;
1060 /* Update computation of how much all possible completions match */
1062 matchcount++;
1063 if (NILP (bestmatch))
1065 bestmatch = eltstring;
1066 bestmatchsize = XSTRING (eltstring)->size;
1068 else
1070 compare = min (bestmatchsize, XSTRING (eltstring)->size);
1071 tem = Fcompare_strings (bestmatch, make_number (0),
1072 make_number (compare),
1073 eltstring, make_number (0),
1074 make_number (compare),
1075 completion_ignore_case ? Qt : Qnil);
1076 if (EQ (tem, Qt))
1077 matchsize = compare;
1078 else if (XINT (tem) < 0)
1079 matchsize = - XINT (tem) - 1;
1080 else
1081 matchsize = XINT (tem) - 1;
1083 if (matchsize < 0)
1084 matchsize = compare;
1085 if (completion_ignore_case)
1087 /* If this is an exact match except for case,
1088 use it as the best match rather than one that is not an
1089 exact match. This way, we get the case pattern
1090 of the actual match. */
1091 if ((matchsize == XSTRING (eltstring)->size
1092 && matchsize < XSTRING (bestmatch)->size)
1094 /* If there is more than one exact match ignoring case,
1095 and one of them is exact including case,
1096 prefer that one. */
1097 /* If there is no exact match ignoring case,
1098 prefer a match that does not change the case
1099 of the input. */
1100 ((matchsize == XSTRING (eltstring)->size)
1102 (matchsize == XSTRING (bestmatch)->size)
1103 && (tem = Fcompare_strings (eltstring, make_number (0),
1104 make_number (XSTRING (string)->size),
1105 string, make_number (0),
1106 Qnil,
1107 Qnil),
1108 EQ (Qt, tem))
1109 && (tem = Fcompare_strings (bestmatch, make_number (0),
1110 make_number (XSTRING (string)->size),
1111 string, make_number (0),
1112 Qnil,
1113 Qnil),
1114 ! EQ (Qt, tem))))
1115 bestmatch = eltstring;
1117 bestmatchsize = matchsize;
1122 if (NILP (bestmatch))
1123 return Qnil; /* No completions found */
1124 /* If we are ignoring case, and there is no exact match,
1125 and no additional text was supplied,
1126 don't change the case of what the user typed. */
1127 if (completion_ignore_case && bestmatchsize == XSTRING (string)->size
1128 && XSTRING (bestmatch)->size > bestmatchsize)
1129 return minibuf_conform_representation (string, bestmatch);
1131 /* Return t if the supplied string is an exact match (counting case);
1132 it does not require any change to be made. */
1133 if (matchcount == 1 && bestmatchsize == XSTRING (string)->size
1134 && (tem = Fcompare_strings (bestmatch, make_number (0),
1135 make_number (bestmatchsize),
1136 string, make_number (0),
1137 make_number (bestmatchsize),
1138 Qnil),
1139 EQ (Qt, tem)))
1140 return Qt;
1142 XSETFASTINT (zero, 0); /* Else extract the part in which */
1143 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1144 return Fsubstring (bestmatch, zero, end);
1147 /* Compare exactly LEN chars of strings at S1 and S2,
1148 ignoring case if appropriate.
1149 Return -1 if strings match,
1150 else number of chars that match at the beginning. */
1153 scmp (s1, s2, len)
1154 register unsigned char *s1, *s2;
1155 int len;
1157 register int l = len;
1159 if (completion_ignore_case)
1161 while (l && DOWNCASE (*s1++) == DOWNCASE (*s2++))
1162 l--;
1164 else
1166 while (l && *s1++ == *s2++)
1167 l--;
1169 if (l == 0)
1170 return -1;
1171 else
1173 int match = len - l;
1175 /* Now *--S1 is the unmatching byte. If it is in the middle of
1176 multi-byte form, we must say that the multi-byte character
1177 there doesn't match. */
1178 while (match && *--s1 >= 0xA0) match--;
1179 return match;
1183 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1184 "Search for partial matches to STRING in ALIST.\n\
1185 Each car of each element of ALIST is tested to see if it begins with STRING.\n\
1186 The value is a list of all the strings from ALIST that match.\n\
1188 ALIST can be an obarray instead of an alist.\n\
1189 Then the print names of all symbols in the obarray are the possible matches.\n\
1191 ALIST can also be a function to do the completion itself.\n\
1192 It receives three arguments: the values STRING, PREDICATE and t.\n\
1193 Whatever it returns becomes the value of `all-completion'.\n\
1195 If optional third argument PREDICATE is non-nil,\n\
1196 it is used to test each possible match.\n\
1197 The match is a candidate only if PREDICATE returns non-nil.\n\
1198 The argument given to PREDICATE is the alist element\n\
1199 or the symbol from the obarray.\n\
1201 If the optional fourth argument HIDE-SPACES is non-nil,\n\
1202 strings in ALIST that start with a space\n\
1203 are ignored unless STRING itself starts with a space.")
1204 (string, alist, predicate, hide_spaces)
1205 Lisp_Object string, alist, predicate, hide_spaces;
1207 Lisp_Object tail, elt, eltstring;
1208 Lisp_Object allmatches;
1209 int list = CONSP (alist) || NILP (alist);
1210 int index, obsize;
1211 Lisp_Object bucket, tem;
1212 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1214 CHECK_STRING (string, 0);
1215 if (!list && !VECTORP (alist))
1217 return call3 (alist, string, predicate, Qt);
1219 allmatches = Qnil;
1221 /* If ALIST is not a list, set TAIL just for gc pro. */
1222 tail = alist;
1223 if (! list)
1225 index = 0;
1226 obsize = XVECTOR (alist)->size;
1227 bucket = XVECTOR (alist)->contents[index];
1230 while (1)
1232 /* Get the next element of the alist or obarray. */
1233 /* Exit the loop if the elements are all used up. */
1234 /* elt gets the alist element or symbol.
1235 eltstring gets the name to check as a completion. */
1237 if (list)
1239 if (NILP (tail))
1240 break;
1241 elt = Fcar (tail);
1242 eltstring = Fcar (elt);
1243 tail = Fcdr (tail);
1245 else
1247 if (XFASTINT (bucket) != 0)
1249 elt = bucket;
1250 eltstring = Fsymbol_name (elt);
1251 if (XSYMBOL (bucket)->next)
1252 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1253 else
1254 XSETFASTINT (bucket, 0);
1256 else if (++index >= obsize)
1257 break;
1258 else
1260 bucket = XVECTOR (alist)->contents[index];
1261 continue;
1265 /* Is this element a possible completion? */
1267 if (STRINGP (eltstring)
1268 && XSTRING (string)->size <= XSTRING (eltstring)->size
1269 /* If HIDE_SPACES, reject alternatives that start with space
1270 unless the input starts with space. */
1271 && ((STRING_BYTES (XSTRING (string)) > 0
1272 && XSTRING (string)->data[0] == ' ')
1273 || XSTRING (eltstring)->data[0] != ' '
1274 || NILP (hide_spaces))
1275 && (tem = Fcompare_strings (eltstring, make_number (0),
1276 make_number (XSTRING (string)->size),
1277 string, make_number (0),
1278 make_number (XSTRING (string)->size),
1279 completion_ignore_case ? Qt : Qnil),
1280 EQ (Qt, tem)))
1282 /* Yes. */
1283 Lisp_Object regexps;
1284 Lisp_Object zero;
1285 XSETFASTINT (zero, 0);
1287 /* Ignore this element if it fails to match all the regexps. */
1288 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1289 regexps = XCONS (regexps)->cdr)
1291 tem = Fstring_match (XCONS (regexps)->car, eltstring, zero);
1292 if (NILP (tem))
1293 break;
1295 if (CONSP (regexps))
1296 continue;
1298 /* Ignore this element if there is a predicate
1299 and the predicate doesn't like it. */
1301 if (!NILP (predicate))
1303 if (EQ (predicate, Qcommandp))
1304 tem = Fcommandp (elt);
1305 else
1307 GCPRO4 (tail, eltstring, allmatches, string);
1308 tem = call1 (predicate, elt);
1309 UNGCPRO;
1311 if (NILP (tem)) continue;
1313 /* Ok => put it on the list. */
1314 allmatches = Fcons (eltstring, allmatches);
1318 return Fnreverse (allmatches);
1321 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
1322 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
1323 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
1324 Lisp_Object Vminibuffer_completing_file_name;
1326 /* This comment supplies the doc string for completing-read,
1327 for make-docfile to see. We cannot put this in the real DEFUN
1328 due to limits in the Unix cpp.
1330 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1331 "Read a string in the minibuffer, with completion.\n\
1332 PROMPT is a string to prompt with; normally it ends in a colon and a space.\n\
1333 TABLE is an alist whose elements' cars are strings, or an obarray.\n\
1334 PREDICATE limits completion to a subset of TABLE.\n\
1335 See `try-completion' and `all-completions' for more details\n\
1336 on completion, TABLE, and PREDICATE.\n\
1338 If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless\n\
1339 the input is (or completes to) an element of TABLE or is null.\n\
1340 If it is also not t, Return does not exit if it does non-null completion.\n\
1341 If the input is null, `completing-read' returns an empty string,\n\
1342 regardless of the value of REQUIRE-MATCH.\n\
1344 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.\n\
1345 If it is (STRING . POSITION), the initial input\n\
1346 is STRING, but point is placed POSITION characters into the string.\n\
1347 HIST, if non-nil, specifies a history list\n\
1348 and optionally the initial position in the list.\n\
1349 It can be a symbol, which is the history list variable to use,\n\
1350 or it can be a cons cell (HISTVAR . HISTPOS).\n\
1351 In that case, HISTVAR is the history list variable to use,\n\
1352 and HISTPOS is the initial position (the position in the list\n\
1353 which INITIAL-INPUT corresponds to).\n\
1354 Positions are counted starting from 1 at the beginning of the list.\n\
1355 DEF, if non-nil, is the default value.\n\
1357 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits\n\
1358 the current input method and the setting of enable-multibyte-characters.\n\
1360 Completion ignores case if the ambient value of\n\
1361 `completion-ignore-case' is non-nil."
1363 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1364 0 /* See immediately above */)
1365 (prompt, table, predicate, require_match, init, hist, def, inherit_input_method)
1366 Lisp_Object prompt, table, predicate, require_match, init, hist, def;
1367 Lisp_Object inherit_input_method;
1369 Lisp_Object val, histvar, histpos, position;
1370 int pos = 0;
1371 int count = specpdl_ptr - specpdl;
1372 struct gcpro gcpro1;
1374 GCPRO1 (def);
1376 specbind (Qminibuffer_completion_table, table);
1377 specbind (Qminibuffer_completion_predicate, predicate);
1378 specbind (Qminibuffer_completion_confirm,
1379 EQ (require_match, Qt) ? Qnil : Qt);
1380 last_exact_completion = Qnil;
1382 position = Qnil;
1383 if (!NILP (init))
1385 if (CONSP (init))
1387 position = Fcdr (init);
1388 init = Fcar (init);
1390 CHECK_STRING (init, 0);
1391 if (!NILP (position))
1393 CHECK_NUMBER (position, 0);
1394 /* Convert to distance from end of input. */
1395 pos = XINT (position) - XSTRING (init)->size;
1399 if (SYMBOLP (hist))
1401 histvar = hist;
1402 histpos = Qnil;
1404 else
1406 histvar = Fcar_safe (hist);
1407 histpos = Fcdr_safe (hist);
1409 if (NILP (histvar))
1410 histvar = Qminibuffer_history;
1411 if (NILP (histpos))
1412 XSETFASTINT (histpos, 0);
1414 val = read_minibuf (NILP (require_match)
1415 ? Vminibuffer_local_completion_map
1416 : Vminibuffer_local_must_match_map,
1417 init, prompt, make_number (pos), 0,
1418 histvar, histpos, def, 0,
1419 !NILP (inherit_input_method));
1421 if (STRINGP (val) && XSTRING (val)->size == 0 && ! NILP (def))
1422 val = def;
1424 RETURN_UNGCPRO (unbind_to (count, val));
1427 Lisp_Object Fminibuffer_completion_help ();
1428 Lisp_Object assoc_for_completion ();
1430 /* Test whether TXT is an exact completion. */
1431 Lisp_Object
1432 test_completion (txt)
1433 Lisp_Object txt;
1435 Lisp_Object tem;
1437 if (CONSP (Vminibuffer_completion_table)
1438 || NILP (Vminibuffer_completion_table))
1439 return assoc_for_completion (txt, Vminibuffer_completion_table);
1440 else if (VECTORP (Vminibuffer_completion_table))
1442 /* Bypass intern-soft as that loses for nil */
1443 tem = oblookup (Vminibuffer_completion_table,
1444 XSTRING (txt)->data,
1445 XSTRING (txt)->size,
1446 STRING_BYTES (XSTRING (txt)));
1447 if (!SYMBOLP (tem))
1449 if (STRING_MULTIBYTE (txt))
1450 txt = Fstring_make_unibyte (txt);
1451 else
1452 txt = Fstring_make_multibyte (txt);
1454 tem = oblookup (Vminibuffer_completion_table,
1455 XSTRING (txt)->data,
1456 XSTRING (txt)->size,
1457 STRING_BYTES (XSTRING (txt)));
1458 if (!SYMBOLP (tem))
1459 return Qnil;
1461 if (!NILP (Vminibuffer_completion_predicate))
1462 return call1 (Vminibuffer_completion_predicate, tem);
1463 else
1464 return Qt;
1466 else
1467 return call3 (Vminibuffer_completion_table, txt,
1468 Vminibuffer_completion_predicate, Qlambda);
1471 /* returns:
1472 * 0 no possible completion
1473 * 1 was already an exact and unique completion
1474 * 3 was already an exact completion
1475 * 4 completed to an exact completion
1476 * 5 some completion happened
1477 * 6 no completion happened
1480 do_completion ()
1482 Lisp_Object completion, tem;
1483 int completedp;
1484 Lisp_Object last;
1485 struct gcpro gcpro1, gcpro2;
1487 completion = Ftry_completion (Fbuffer_string (), Vminibuffer_completion_table,
1488 Vminibuffer_completion_predicate);
1489 last = last_exact_completion;
1490 last_exact_completion = Qnil;
1492 GCPRO2 (completion, last);
1494 if (NILP (completion))
1496 bitch_at_user ();
1497 temp_echo_area_glyphs (" [No match]");
1498 UNGCPRO;
1499 return 0;
1502 if (EQ (completion, Qt)) /* exact and unique match */
1504 UNGCPRO;
1505 return 1;
1508 /* compiler bug */
1509 tem = Fstring_equal (completion, Fbuffer_string());
1510 completedp = NILP (tem);
1511 if (completedp)
1513 Ferase_buffer (); /* Some completion happened */
1514 Finsert (1, &completion);
1517 /* It did find a match. Do we match some possibility exactly now? */
1518 tem = test_completion (Fbuffer_string ());
1519 if (NILP (tem))
1521 /* not an exact match */
1522 UNGCPRO;
1523 if (completedp)
1524 return 5;
1525 else if (auto_help)
1526 Fminibuffer_completion_help ();
1527 else
1528 temp_echo_area_glyphs (" [Next char not unique]");
1529 return 6;
1531 else if (completedp)
1533 UNGCPRO;
1534 return 4;
1536 /* If the last exact completion and this one were the same,
1537 it means we've already given a "Complete but not unique"
1538 message and the user's hit TAB again, so now we give him help. */
1539 last_exact_completion = completion;
1540 if (!NILP (last))
1542 tem = Fbuffer_string ();
1543 if (!NILP (Fequal (tem, last)))
1544 Fminibuffer_completion_help ();
1546 UNGCPRO;
1547 return 3;
1550 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1552 Lisp_Object
1553 assoc_for_completion (key, list)
1554 register Lisp_Object key;
1555 Lisp_Object list;
1557 register Lisp_Object tail;
1559 for (tail = list; !NILP (tail); tail = Fcdr (tail))
1561 register Lisp_Object elt, tem, thiscar;
1562 elt = Fcar (tail);
1563 if (!CONSP (elt)) continue;
1564 thiscar = Fcar (elt);
1565 if (!STRINGP (thiscar))
1566 continue;
1567 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1568 key, make_number (0), Qnil,
1569 completion_ignore_case ? Qt : Qnil);
1570 if (EQ (tem, Qt))
1571 return elt;
1572 QUIT;
1574 return Qnil;
1577 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
1578 "Complete the minibuffer contents as far as possible.\n\
1579 Return nil if there is no valid completion, else t.\n\
1580 If no characters can be completed, display a list of possible completions.\n\
1581 If you repeat this command after it displayed such a list,\n\
1582 scroll the window of possible completions.")
1585 register int i;
1586 Lisp_Object window, tem;
1588 /* If the previous command was not this,
1589 mark the completion buffer obsolete. */
1590 if (! EQ (current_kboard->Vlast_command, Vthis_command))
1591 Vminibuf_scroll_window = Qnil;
1593 window = Vminibuf_scroll_window;
1594 /* If there's a fresh completion window with a live buffer,
1595 and this command is repeated, scroll that window. */
1596 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
1597 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
1599 struct buffer *obuf = current_buffer;
1601 Fset_buffer (XWINDOW (window)->buffer);
1602 tem = Fpos_visible_in_window_p (make_number (ZV), window);
1603 if (! NILP (tem))
1604 /* If end is in view, scroll up to the beginning. */
1605 Fset_window_start (window, make_number (BEGV), Qnil);
1606 else
1607 /* Else scroll down one screen. */
1608 Fscroll_other_window (Qnil);
1610 set_buffer_internal (obuf);
1611 return Qnil;
1614 i = do_completion ();
1615 switch (i)
1617 case 0:
1618 return Qnil;
1620 case 1:
1621 temp_echo_area_glyphs (" [Sole completion]");
1622 break;
1624 case 3:
1625 temp_echo_area_glyphs (" [Complete, but not unique]");
1626 break;
1629 return Qt;
1632 /* Subroutines of Fminibuffer_complete_and_exit. */
1634 /* This one is called by internal_condition_case to do the real work. */
1636 Lisp_Object
1637 complete_and_exit_1 ()
1639 return make_number (do_completion ());
1642 /* This one is called by internal_condition_case if an error happens.
1643 Pretend the current value is an exact match. */
1645 Lisp_Object
1646 complete_and_exit_2 (ignore)
1647 Lisp_Object ignore;
1649 return make_number (1);
1652 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
1653 Sminibuffer_complete_and_exit, 0, 0, "",
1654 "If the minibuffer contents is a valid completion then exit.\n\
1655 Otherwise try to complete it. If completion leads to a valid completion,\n\
1656 a repetition of this command will exit.")
1659 register int i;
1660 Lisp_Object val;
1662 /* Allow user to specify null string */
1663 if (XFASTINT (current_buffer->prompt_end_charpos) == ZV)
1664 goto exit;
1666 if (!NILP (test_completion (Fbuffer_string ())))
1667 goto exit;
1669 /* Call do_completion, but ignore errors. */
1670 val = internal_condition_case (complete_and_exit_1, Qerror,
1671 complete_and_exit_2);
1673 i = XFASTINT (val);
1674 switch (i)
1676 case 1:
1677 case 3:
1678 goto exit;
1680 case 4:
1681 if (!NILP (Vminibuffer_completion_confirm))
1683 temp_echo_area_glyphs (" [Confirm]");
1684 return Qnil;
1686 else
1687 goto exit;
1689 default:
1690 return Qnil;
1692 exit:
1693 Fthrow (Qexit, Qnil);
1694 /* NOTREACHED */
1697 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
1698 0, 0, "",
1699 "Complete the minibuffer contents at most a single word.\n\
1700 After one word is completed as much as possible, a space or hyphen\n\
1701 is added, provided that matches some possible completion.\n\
1702 Return nil if there is no valid completion, else t.")
1705 Lisp_Object completion, tem, tem1;
1706 register int i, i_byte;
1707 register unsigned char *completion_string;
1708 struct gcpro gcpro1, gcpro2;
1710 /* We keep calling Fbuffer_string rather than arrange for GC to
1711 hold onto a pointer to one of the strings thus made. */
1713 completion = Ftry_completion (Fbuffer_string (),
1714 Vminibuffer_completion_table,
1715 Vminibuffer_completion_predicate);
1716 if (NILP (completion))
1718 bitch_at_user ();
1719 temp_echo_area_glyphs (" [No match]");
1720 return Qnil;
1722 if (EQ (completion, Qt))
1723 return Qnil;
1725 #if 0 /* How the below code used to look, for reference. */
1726 tem = Fbuffer_string ();
1727 b = XSTRING (tem)->data;
1728 i = ZV - 1 - XSTRING (completion)->size;
1729 p = XSTRING (completion)->data;
1730 if (i > 0 ||
1731 0 <= scmp (b, p, ZV - 1))
1733 i = 1;
1734 /* Set buffer to longest match of buffer tail and completion head. */
1735 while (0 <= scmp (b + i, p, ZV - 1 - i))
1736 i++;
1737 del_range (1, i + 1);
1738 SET_PT (ZV);
1740 #else /* Rewritten code */
1742 int buffer_nchars, completion_nchars;
1744 CHECK_STRING (completion, 0);
1745 tem = Fbuffer_string ();
1746 GCPRO2 (completion, tem);
1747 /* If reading a file name,
1748 expand any $ENVVAR refs in the buffer and in TEM. */
1749 if (! NILP (Vminibuffer_completing_file_name))
1751 Lisp_Object substituted;
1752 substituted = Fsubstitute_in_file_name (tem);
1753 if (! EQ (substituted, tem))
1755 tem = substituted;
1756 Ferase_buffer ();
1757 insert_from_string (tem, 0, 0, XSTRING (tem)->size,
1758 STRING_BYTES (XSTRING (tem)), 0);
1761 buffer_nchars = XSTRING (tem)->size; /* ie ZV - BEGV */
1762 completion_nchars = XSTRING (completion)->size;
1763 i = buffer_nchars - completion_nchars;
1764 if (i > 0
1766 (tem1 = Fcompare_strings (tem, make_number (0),
1767 make_number (buffer_nchars),
1768 completion, make_number (0),
1769 make_number (buffer_nchars),
1770 completion_ignore_case ? Qt : Qnil),
1771 ! EQ (tem1, Qt)))
1773 int start_pos;
1775 /* Set buffer to longest match of buffer tail and completion head. */
1776 if (i <= 0) i = 1;
1777 start_pos= i;
1778 buffer_nchars -= i;
1779 while (i > 0)
1781 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
1782 completion, make_number (0),
1783 make_number (buffer_nchars),
1784 completion_ignore_case ? Qt : Qnil);
1785 start_pos++;
1786 if (EQ (tem1, Qt))
1787 break;
1788 i++;
1789 buffer_nchars--;
1791 del_range (1, i + 1);
1792 SET_PT_BOTH (ZV, ZV_BYTE);
1794 UNGCPRO;
1796 #endif /* Rewritten code */
1799 int prompt_end_charpos, prompt_end_bytepos;
1800 prompt_end_charpos = XFASTINT (current_buffer->prompt_end_charpos);
1801 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
1802 i = ZV - prompt_end_charpos;
1803 i_byte = ZV_BYTE - prompt_end_bytepos;
1806 /* If completion finds next char not unique,
1807 consider adding a space or a hyphen. */
1808 if (i == XSTRING (completion)->size)
1810 GCPRO1 (completion);
1811 tem = Ftry_completion (concat2 (Fbuffer_string (), build_string (" ")),
1812 Vminibuffer_completion_table,
1813 Vminibuffer_completion_predicate);
1814 UNGCPRO;
1816 if (STRINGP (tem))
1817 completion = tem;
1818 else
1820 GCPRO1 (completion);
1821 tem =
1822 Ftry_completion (concat2 (Fbuffer_string (), build_string ("-")),
1823 Vminibuffer_completion_table,
1824 Vminibuffer_completion_predicate);
1825 UNGCPRO;
1827 if (STRINGP (tem))
1828 completion = tem;
1832 /* Now find first word-break in the stuff found by completion.
1833 i gets index in string of where to stop completing. */
1835 int len, c;
1836 int bytes = STRING_BYTES (XSTRING (completion));
1837 completion_string = XSTRING (completion)->data;
1838 for (; i_byte < STRING_BYTES (XSTRING (completion)); i_byte += len, i++)
1840 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
1841 bytes - i_byte,
1842 len);
1843 if (SYNTAX (c) != Sword)
1845 i_byte += len;
1846 i++;
1847 break;
1852 /* If got no characters, print help for user. */
1854 if (i == ZV - XFASTINT (current_buffer->prompt_end_charpos))
1856 if (auto_help)
1857 Fminibuffer_completion_help ();
1858 return Qnil;
1861 /* Otherwise insert in minibuffer the chars we got */
1863 Ferase_buffer ();
1864 insert_from_string (completion, 0, 0, i, i_byte, 1);
1865 return Qt;
1868 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
1869 1, 1, 0,
1870 "Display the list of completions, COMPLETIONS, using `standard-output'.\n\
1871 Each element may be just a symbol or string\n\
1872 or may be a list of two strings to be printed as if concatenated.\n\
1873 `standard-output' must be a buffer.\n\
1874 The actual completion alternatives, as inserted, are given `mouse-face'\n\
1875 properties of `highlight'.\n\
1876 At the end, this runs the normal hook `completion-setup-hook'.\n\
1877 It can find the completion buffer in `standard-output'.")
1878 (completions)
1879 Lisp_Object completions;
1881 Lisp_Object tail, elt;
1882 register int i;
1883 int column = 0;
1884 struct gcpro gcpro1, gcpro2;
1885 struct buffer *old = current_buffer;
1886 int first = 1;
1888 /* Note that (when it matters) every variable
1889 points to a non-string that is pointed to by COMPLETIONS,
1890 except for ELT. ELT can be pointing to a string
1891 when terpri or Findent_to calls a change hook. */
1892 elt = Qnil;
1893 GCPRO2 (completions, elt);
1895 if (BUFFERP (Vstandard_output))
1896 set_buffer_internal (XBUFFER (Vstandard_output));
1898 if (NILP (completions))
1899 write_string ("There are no possible completions of what you have typed.",
1900 -1);
1901 else
1903 write_string ("Possible completions are:", -1);
1904 for (tail = completions, i = 0; !NILP (tail); tail = Fcdr (tail), i++)
1906 Lisp_Object tem, string;
1907 int length;
1908 Lisp_Object startpos, endpos;
1910 elt = Fcar (tail);
1911 /* Compute the length of this element. */
1912 if (CONSP (elt))
1914 tem = XCAR (elt);
1915 CHECK_STRING (tem, 0);
1916 length = XSTRING (tem)->size;
1918 tem = Fcar (XCDR (elt));
1919 CHECK_STRING (tem, 0);
1920 length += XSTRING (tem)->size;
1922 else
1924 CHECK_STRING (elt, 0);
1925 length = XSTRING (elt)->size;
1928 /* This does a bad job for narrower than usual windows.
1929 Sadly, the window it will appear in is not known
1930 until after the text has been made. */
1932 if (BUFFERP (Vstandard_output))
1933 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
1935 /* If the previous completion was very wide,
1936 or we have two on this line already,
1937 don't put another on the same line. */
1938 if (column > 33 || first
1939 /* If this is really wide, don't put it second on a line. */
1940 || (column > 0 && length > 45))
1942 Fterpri (Qnil);
1943 column = 0;
1945 /* Otherwise advance to column 35. */
1946 else
1948 if (BUFFERP (Vstandard_output))
1950 tem = Findent_to (make_number (35), make_number (2));
1952 column = XINT (tem);
1954 else
1958 write_string (" ", -1);
1959 column++;
1961 while (column < 35);
1965 if (BUFFERP (Vstandard_output))
1967 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
1968 Fset_text_properties (startpos, endpos,
1969 Qnil, Vstandard_output);
1972 /* Output this element.
1973 If necessary, convert it to unibyte or to multibyte first. */
1974 if (CONSP (elt))
1975 string = Fcar (elt);
1976 else
1977 string = elt;
1978 if (NILP (current_buffer->enable_multibyte_characters)
1979 && STRING_MULTIBYTE (string))
1980 string = Fstring_make_unibyte (string);
1981 else if (!NILP (current_buffer->enable_multibyte_characters)
1982 && !STRING_MULTIBYTE (string))
1983 string = Fstring_make_multibyte (string);
1985 if (BUFFERP (Vstandard_output))
1987 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
1989 Fprinc (string, Qnil);
1991 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
1993 Fput_text_property (startpos, endpos,
1994 Qmouse_face, intern ("highlight"),
1995 Vstandard_output);
1997 else
1999 Fprinc (string, Qnil);
2002 /* Output the annotation for this element. */
2003 if (CONSP (elt))
2005 if (BUFFERP (Vstandard_output))
2007 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2009 Fprinc (Fcar (Fcdr (elt)), Qnil);
2011 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2013 Fset_text_properties (startpos, endpos, Qnil,
2014 Vstandard_output);
2016 else
2018 Fprinc (Fcar (Fcdr (elt)), Qnil);
2023 /* Update COLUMN for what we have output. */
2024 column += length;
2026 /* If output is to a buffer, recompute COLUMN in a way
2027 that takes account of character widths. */
2028 if (BUFFERP (Vstandard_output))
2030 tem = Fcurrent_column ();
2031 column = XINT (tem);
2034 first = 0;
2038 UNGCPRO;
2040 if (BUFFERP (Vstandard_output))
2041 set_buffer_internal (old);
2043 if (!NILP (Vrun_hooks))
2044 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2046 return Qnil;
2049 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2050 0, 0, "",
2051 "Display a list of possible completions of the current minibuffer contents.")
2054 Lisp_Object completions;
2056 message ("Making completion list...");
2057 completions = Fall_completions (Fbuffer_string (),
2058 Vminibuffer_completion_table,
2059 Vminibuffer_completion_predicate,
2060 Qt);
2061 clear_message (1, 0);
2063 if (NILP (completions))
2065 bitch_at_user ();
2066 temp_echo_area_glyphs (" [No completions]");
2068 else
2069 internal_with_output_to_temp_buffer ("*Completions*",
2070 Fdisplay_completion_list,
2071 Fsort (completions, Qstring_lessp));
2072 return Qnil;
2075 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2076 "Terminate minibuffer input.")
2079 if (INTEGERP (last_command_char))
2080 internal_self_insert (XINT (last_command_char), 0);
2081 else
2082 bitch_at_user ();
2084 Fthrow (Qexit, Qnil);
2087 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2088 "Terminate this minibuffer argument.")
2091 Fthrow (Qexit, Qnil);
2094 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2095 "Return current depth of activations of minibuffer, a nonnegative integer.")
2098 return make_number (minibuf_level);
2101 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2102 "Return the prompt string of the currently-active minibuffer.\n\
2103 If no minibuffer is active, return nil.")
2106 return Fcopy_sequence (minibuf_prompt);
2109 DEFUN ("minibuffer-prompt-width", Fminibuffer_prompt_width,
2110 Sminibuffer_prompt_width, 0, 0, 0,
2111 "Return the display width of the minibuffer prompt.")
2114 return make_number (minibuf_prompt_width);
2118 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
2119 Sminibuffer_prompt_end, 0, 0, 0,
2120 "Return the end buffer position of the mini-buffer prompt.\n\
2121 Value is 0 if current buffer is not a mini-buffer.")
2124 return (NILP (current_buffer->prompt_end_charpos)
2125 ? make_number (0)
2126 : make_number (current_buffer->prompt_end_charpos));
2131 /* Temporarily display the string M at the end of the current
2132 minibuffer contents. This is used to display things like
2133 "[No Match]" when the user requests a completion for a prefix
2134 that has no possible completions, and other quick, unobtrusive
2135 messages. */
2137 void
2138 temp_echo_area_glyphs (m)
2139 char *m;
2141 int osize = ZV;
2142 int osize_byte = ZV_BYTE;
2143 int opoint = PT;
2144 int opoint_byte = PT_BYTE;
2145 Lisp_Object oinhibit;
2146 oinhibit = Vinhibit_quit;
2148 /* Clear out any old echo-area message to make way for our new thing. */
2149 message (0);
2151 SET_PT_BOTH (osize, osize_byte);
2152 insert_string (m);
2153 SET_PT_BOTH (opoint, opoint_byte);
2154 Vinhibit_quit = Qt;
2155 Fsit_for (make_number (2), Qnil, Qnil);
2156 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2157 SET_PT_BOTH (opoint, opoint_byte);
2158 if (!NILP (Vquit_flag))
2160 Vquit_flag = Qnil;
2161 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2163 Vinhibit_quit = oinhibit;
2166 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2167 1, 1, 0,
2168 "Temporarily display STRING at the end of the minibuffer.\n\
2169 The text is displayed for two seconds,\n\
2170 or until the next input event arrives, whichever comes first.")
2171 (string)
2172 Lisp_Object string;
2174 temp_echo_area_glyphs (XSTRING (string)->data);
2175 return Qnil;
2178 void
2179 init_minibuf_once ()
2181 Vminibuffer_list = Qnil;
2182 staticpro (&Vminibuffer_list);
2185 void
2186 syms_of_minibuf ()
2188 minibuf_level = 0;
2189 minibuf_prompt = Qnil;
2190 staticpro (&minibuf_prompt);
2192 minibuf_save_list = Qnil;
2193 staticpro (&minibuf_save_list);
2195 Qread_file_name_internal = intern ("read-file-name-internal");
2196 staticpro (&Qread_file_name_internal);
2198 Qminibuffer_default = intern ("minibuffer-default");
2199 staticpro (&Qminibuffer_default);
2200 Fset (Qminibuffer_default, Qnil);
2202 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2203 staticpro (&Qminibuffer_completion_table);
2205 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2206 staticpro (&Qminibuffer_completion_confirm);
2208 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2209 staticpro (&Qminibuffer_completion_predicate);
2211 staticpro (&last_exact_completion);
2212 last_exact_completion = Qnil;
2214 staticpro (&last_minibuf_string);
2215 last_minibuf_string = Qnil;
2217 Quser_variable_p = intern ("user-variable-p");
2218 staticpro (&Quser_variable_p);
2220 Qminibuffer_history = intern ("minibuffer-history");
2221 staticpro (&Qminibuffer_history);
2223 Qbuffer_name_history = intern ("buffer-name-history");
2224 staticpro (&Qbuffer_name_history);
2225 Fset (Qbuffer_name_history, Qnil);
2227 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2228 staticpro (&Qminibuffer_setup_hook);
2230 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2231 staticpro (&Qminibuffer_exit_hook);
2233 Qhistory_length = intern ("history-length");
2234 staticpro (&Qhistory_length);
2236 Qcurrent_input_method = intern ("current-input-method");
2237 staticpro (&Qcurrent_input_method);
2239 Qactivate_input_method = intern ("activate-input-method");
2240 staticpro (&Qactivate_input_method);
2242 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2243 "If this is non-nil, `read-buffer' does its work by calling this function.");
2244 Vread_buffer_function = Qnil;
2246 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2247 "Normal hook run just after entry to minibuffer.");
2248 Vminibuffer_setup_hook = Qnil;
2250 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2251 "Normal hook run just after exit from minibuffer.");
2252 Vminibuffer_exit_hook = Qnil;
2254 DEFVAR_LISP ("history-length", &Vhistory_length,
2255 "*Maximum length for history lists before truncation takes place.\n\
2256 A number means that length; t means infinite. Truncation takes place\n\
2257 just after a new element is inserted. Setting the history-length\n\
2258 property of a history variable overrides this default.");
2259 XSETFASTINT (Vhistory_length, 30);
2261 DEFVAR_BOOL ("completion-auto-help", &auto_help,
2262 "*Non-nil means automatically provide help for invalid completion input.");
2263 auto_help = 1;
2265 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2266 "Non-nil means don't consider case significant in completion.");
2267 completion_ignore_case = 0;
2269 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2270 "*Non-nil means to allow minibuffer commands while in the minibuffer.\n\
2271 This variable makes a difference whenever the minibuffer window is active.");
2272 enable_recursive_minibuffers = 0;
2274 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2275 "Alist or obarray used for completion in the minibuffer.\n\
2276 This becomes the ALIST argument to `try-completion' and `all-completion'.\n\
2278 The value may alternatively be a function, which is given three arguments:\n\
2279 STRING, the current buffer contents;\n\
2280 PREDICATE, the predicate for filtering possible matches;\n\
2281 CODE, which says what kind of things to do.\n\
2282 CODE can be nil, t or `lambda'.\n\
2283 nil means to return the best completion of STRING, or nil if there is none.\n\
2284 t means to return a list of all possible completions of STRING.\n\
2285 `lambda' means to return t if STRING is a valid completion as it stands.");
2286 Vminibuffer_completion_table = Qnil;
2288 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2289 "Within call to `completing-read', this holds the PREDICATE argument.");
2290 Vminibuffer_completion_predicate = Qnil;
2292 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2293 "Non-nil => demand confirmation of completion before exiting minibuffer.");
2294 Vminibuffer_completion_confirm = Qnil;
2296 DEFVAR_LISP ("minibuffer-completing-file-name",
2297 &Vminibuffer_completing_file_name,
2298 "Non-nil means completing file names.");
2299 Vminibuffer_completing_file_name = Qnil;
2301 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2302 "Value that `help-form' takes on inside the minibuffer.");
2303 Vminibuffer_help_form = Qnil;
2305 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2306 "History list symbol to add minibuffer values to.\n\
2307 Each string of minibuffer input, as it appears on exit from the minibuffer,\n\
2308 is added with\n\
2309 (set minibuffer-history-variable\n\
2310 (cons STRING (symbol-value minibuffer-history-variable)))");
2311 XSETFASTINT (Vminibuffer_history_variable, 0);
2313 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2314 "Current position of redoing in the history list.");
2315 Vminibuffer_history_position = Qnil;
2317 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2318 "*Non-nil means entering the minibuffer raises the minibuffer's frame.\n\
2319 Some uses of the echo area also raise that frame (since they use it too).");
2320 minibuffer_auto_raise = 0;
2322 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2323 "List of regexps that should restrict possible completions.");
2324 Vcompletion_regexp_list = Qnil;
2326 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2327 &minibuffer_allow_text_properties,
2328 "Non-nil means `read-from-minibuffer' should not discard text properties.\n\
2329 This also affects `read-string', but it does not affect `read-minibuffer',\n\
2330 `read-no-blanks-input', or any of the functions that do minibuffer input\n\
2331 with completion; they always discard text properties.");
2332 minibuffer_allow_text_properties = 0;
2334 defsubr (&Sset_minibuffer_window);
2335 defsubr (&Sread_from_minibuffer);
2336 defsubr (&Seval_minibuffer);
2337 defsubr (&Sread_minibuffer);
2338 defsubr (&Sread_string);
2339 defsubr (&Sread_command);
2340 defsubr (&Sread_variable);
2341 defsubr (&Sread_buffer);
2342 defsubr (&Sread_no_blanks_input);
2343 defsubr (&Sminibuffer_depth);
2344 defsubr (&Sminibuffer_prompt);
2345 defsubr (&Sminibuffer_prompt_width);
2346 defsubr (&Sminibuffer_prompt_end);
2348 defsubr (&Stry_completion);
2349 defsubr (&Sall_completions);
2350 defsubr (&Scompleting_read);
2351 defsubr (&Sminibuffer_complete);
2352 defsubr (&Sminibuffer_complete_word);
2353 defsubr (&Sminibuffer_complete_and_exit);
2354 defsubr (&Sdisplay_completion_list);
2355 defsubr (&Sminibuffer_completion_help);
2357 defsubr (&Sself_insert_and_exit);
2358 defsubr (&Sexit_minibuffer);
2360 defsubr (&Sminibuffer_message);
2363 void
2364 keys_of_minibuf ()
2366 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
2367 "abort-recursive-edit");
2368 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
2369 "exit-minibuffer");
2370 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
2371 "exit-minibuffer");
2373 initial_define_key (Vminibuffer_local_ns_map, Ctl ('g'),
2374 "abort-recursive-edit");
2375 initial_define_key (Vminibuffer_local_ns_map, Ctl ('m'),
2376 "exit-minibuffer");
2377 initial_define_key (Vminibuffer_local_ns_map, Ctl ('j'),
2378 "exit-minibuffer");
2380 initial_define_key (Vminibuffer_local_ns_map, ' ',
2381 "exit-minibuffer");
2382 initial_define_key (Vminibuffer_local_ns_map, '\t',
2383 "exit-minibuffer");
2384 initial_define_key (Vminibuffer_local_ns_map, '?',
2385 "self-insert-and-exit");
2387 initial_define_key (Vminibuffer_local_completion_map, Ctl ('g'),
2388 "abort-recursive-edit");
2389 initial_define_key (Vminibuffer_local_completion_map, Ctl ('m'),
2390 "exit-minibuffer");
2391 initial_define_key (Vminibuffer_local_completion_map, Ctl ('j'),
2392 "exit-minibuffer");
2394 initial_define_key (Vminibuffer_local_completion_map, '\t',
2395 "minibuffer-complete");
2396 initial_define_key (Vminibuffer_local_completion_map, ' ',
2397 "minibuffer-complete-word");
2398 initial_define_key (Vminibuffer_local_completion_map, '?',
2399 "minibuffer-completion-help");
2401 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('g'),
2402 "abort-recursive-edit");
2403 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
2404 "minibuffer-complete-and-exit");
2405 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
2406 "minibuffer-complete-and-exit");
2407 initial_define_key (Vminibuffer_local_must_match_map, '\t',
2408 "minibuffer-complete");
2409 initial_define_key (Vminibuffer_local_must_match_map, ' ',
2410 "minibuffer-complete-word");
2411 initial_define_key (Vminibuffer_local_must_match_map, '?',
2412 "minibuffer-completion-help");