(cvs-mode-add-change-log-entry-other-window): Use a directory
[emacs.git] / src / minibuf.c
blobc2654d02b04a2b2b734068216ebb7e0348c07bfa
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
3 2001, 2002, 2003, 2004, 2005,
4 2006, 2007 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
11 any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
24 #include <config.h>
25 #include <stdio.h>
27 #include "lisp.h"
28 #include "commands.h"
29 #include "buffer.h"
30 #include "charset.h"
31 #include "dispextern.h"
32 #include "keyboard.h"
33 #include "frame.h"
34 #include "window.h"
35 #include "syntax.h"
36 #include "intervals.h"
37 #include "keymap.h"
39 extern int quit_char;
41 /* List of buffers for use as minibuffers.
42 The first element of the list is used for the outermost minibuffer
43 invocation, the next element is used for a recursive minibuffer
44 invocation, etc. The list is extended at the end as deeper
45 minibuffer recursions are encountered. */
47 Lisp_Object Vminibuffer_list;
49 /* Data to remember during recursive minibuffer invocations */
51 Lisp_Object minibuf_save_list;
53 /* Depth in minibuffer invocations. */
55 int minibuf_level;
57 /* Nonzero means display completion help for invalid input. */
59 Lisp_Object Vcompletion_auto_help;
61 /* The maximum length of a minibuffer history. */
63 Lisp_Object Qhistory_length, Vhistory_length;
65 /* No duplicates in history. */
67 int history_delete_duplicates;
69 /* Non-nil means add new input to history. */
71 Lisp_Object Vhistory_add_new_input;
73 /* Fread_minibuffer leaves the input here as a string. */
75 Lisp_Object last_minibuf_string;
77 /* Nonzero means let functions called when within a minibuffer
78 invoke recursive minibuffers (to read arguments, or whatever) */
80 int enable_recursive_minibuffers;
82 /* Nonzero means don't ignore text properties
83 in Fread_from_minibuffer. */
85 int minibuffer_allow_text_properties;
87 /* help-form is bound to this while in the minibuffer. */
89 Lisp_Object Vminibuffer_help_form;
91 /* Variable which is the history list to add minibuffer values to. */
93 Lisp_Object Vminibuffer_history_variable;
95 /* Current position in the history list (adjusted by M-n and M-p). */
97 Lisp_Object Vminibuffer_history_position;
99 /* Text properties that are added to minibuffer prompts.
100 These are in addition to the basic `field' property, and stickiness
101 properties. */
103 Lisp_Object Vminibuffer_prompt_properties;
105 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
107 Lisp_Object Qread_file_name_internal;
109 /* Normal hooks for entry to and exit from minibuffer. */
111 Lisp_Object Qminibuffer_setup_hook, Vminibuffer_setup_hook;
112 Lisp_Object Qminibuffer_exit_hook, Vminibuffer_exit_hook;
114 /* Function to call to read a buffer name. */
115 Lisp_Object Vread_buffer_function;
117 /* Nonzero means completion ignores case. */
119 int completion_ignore_case;
121 /* List of regexps that should restrict possible completions. */
123 Lisp_Object Vcompletion_regexp_list;
125 /* Nonzero means raise the minibuffer frame when the minibuffer
126 is entered. */
128 int minibuffer_auto_raise;
130 /* If last completion attempt reported "Complete but not unique"
131 then this is the string completed then; otherwise this is nil. */
133 static Lisp_Object last_exact_completion;
135 /* Keymap for reading expressions. */
136 Lisp_Object Vread_expression_map;
138 Lisp_Object Vminibuffer_completion_table, Qminibuffer_completion_table;
139 Lisp_Object Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
140 Lisp_Object Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
141 Lisp_Object Vminibuffer_completing_file_name;
143 Lisp_Object Quser_variable_p;
145 Lisp_Object Qminibuffer_default;
147 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
149 Lisp_Object Qcase_fold_search;
151 Lisp_Object Qread_expression_history;
153 extern Lisp_Object Voverriding_local_map;
155 extern Lisp_Object Qmouse_face;
157 extern Lisp_Object Qfield;
159 /* Put minibuf on currently selected frame's minibuffer.
160 We do this whenever the user starts a new minibuffer
161 or when a minibuffer exits. */
163 void
164 choose_minibuf_frame ()
166 if (FRAMEP (selected_frame)
167 && FRAME_LIVE_P (XFRAME (selected_frame))
168 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
170 struct frame *sf = XFRAME (selected_frame);
171 Lisp_Object buffer;
173 /* I don't think that any frames may validly have a null minibuffer
174 window anymore. */
175 if (NILP (sf->minibuffer_window))
176 abort ();
178 /* Under X, we come here with minibuf_window being the
179 minibuffer window of the unused termcap window created in
180 init_window_once. That window doesn't have a buffer. */
181 buffer = XWINDOW (minibuf_window)->buffer;
182 if (BUFFERP (buffer))
183 Fset_window_buffer (sf->minibuffer_window, buffer, Qnil);
184 minibuf_window = sf->minibuffer_window;
187 /* Make sure no other frame has a minibuffer as its selected window,
188 because the text would not be displayed in it, and that would be
189 confusing. Only allow the selected frame to do this,
190 and that only if the minibuffer is active. */
192 Lisp_Object tail, frame;
194 FOR_EACH_FRAME (tail, frame)
195 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
196 && !(EQ (frame, selected_frame)
197 && minibuf_level > 0))
198 Fset_frame_selected_window (frame, Fframe_first_window (frame));
202 Lisp_Object
203 choose_minibuf_frame_1 (ignore)
204 Lisp_Object ignore;
206 choose_minibuf_frame ();
207 return Qnil;
210 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
211 Sset_minibuffer_window, 1, 1, 0,
212 doc: /* Specify which minibuffer window to use for the minibuffer.
213 This affects where the minibuffer is displayed if you put text in it
214 without invoking the usual minibuffer commands. */)
215 (window)
216 Lisp_Object window;
218 CHECK_WINDOW (window);
219 if (! MINI_WINDOW_P (XWINDOW (window)))
220 error ("Window is not a minibuffer window");
222 minibuf_window = window;
224 return window;
228 /* Actual minibuffer invocation. */
230 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
231 static Lisp_Object run_exit_minibuf_hook P_ ((Lisp_Object));
232 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
233 Lisp_Object, Lisp_Object,
234 int, Lisp_Object,
235 Lisp_Object, Lisp_Object,
236 int, int));
237 static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
238 Lisp_Object, Lisp_Object,
239 int, Lisp_Object,
240 Lisp_Object, Lisp_Object,
241 int, int));
242 static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
245 /* Read a Lisp object from VAL and return it. If VAL is an empty
246 string, and DEFALT is a string, read from DEFALT instead of VAL. */
248 static Lisp_Object
249 string_to_object (val, defalt)
250 Lisp_Object val, defalt;
252 struct gcpro gcpro1, gcpro2;
253 Lisp_Object expr_and_pos;
254 int pos;
256 GCPRO2 (val, defalt);
258 if (STRINGP (val) && SCHARS (val) == 0
259 && STRINGP (defalt))
260 val = defalt;
262 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
263 pos = XINT (Fcdr (expr_and_pos));
264 if (pos != SCHARS (val))
266 /* Ignore trailing whitespace; any other trailing junk
267 is an error. */
268 int i;
269 pos = string_char_to_byte (val, pos);
270 for (i = pos; i < SBYTES (val); i++)
272 int c = SREF (val, i);
273 if (c != ' ' && c != '\t' && c != '\n')
274 error ("Trailing garbage following expression");
278 val = Fcar (expr_and_pos);
279 RETURN_UNGCPRO (val);
283 /* Like read_minibuf but reading from stdin. This function is called
284 from read_minibuf to do the job if noninteractive. */
286 static Lisp_Object
287 read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
288 histvar, histpos, defalt, allow_props,
289 inherit_input_method)
290 Lisp_Object map;
291 Lisp_Object initial;
292 Lisp_Object prompt;
293 Lisp_Object backup_n;
294 int expflag;
295 Lisp_Object histvar;
296 Lisp_Object histpos;
297 Lisp_Object defalt;
298 int allow_props;
299 int inherit_input_method;
301 int size, len;
302 char *line, *s;
303 Lisp_Object val;
305 fprintf (stdout, "%s", SDATA (prompt));
306 fflush (stdout);
308 val = Qnil;
309 size = 100;
310 len = 0;
311 line = (char *) xmalloc (size * sizeof *line);
312 while ((s = fgets (line + len, size - len, stdin)) != NULL
313 && (len = strlen (line),
314 len == size - 1 && line[len - 1] != '\n'))
316 size *= 2;
317 line = (char *) xrealloc (line, size);
320 if (s)
322 len = strlen (line);
324 if (len > 0 && line[len - 1] == '\n')
325 line[--len] = '\0';
327 val = build_string (line);
328 xfree (line);
330 else
332 xfree (line);
333 error ("Error reading from stdin");
336 /* If Lisp form desired instead of string, parse it. */
337 if (expflag)
338 val = string_to_object (val, defalt);
340 return val;
343 DEFUN ("minibufferp", Fminibufferp,
344 Sminibufferp, 0, 1, 0,
345 doc: /* Return t if BUFFER is a minibuffer.
346 No argument or nil as argument means use current buffer as BUFFER.
347 BUFFER can be a buffer or a buffer name. */)
348 (buffer)
349 Lisp_Object buffer;
351 Lisp_Object tem;
353 if (NILP (buffer))
354 buffer = Fcurrent_buffer ();
355 else if (STRINGP (buffer))
356 buffer = Fget_buffer (buffer);
357 else
358 CHECK_BUFFER (buffer);
360 tem = Fmemq (buffer, Vminibuffer_list);
361 return ! NILP (tem) ? Qt : Qnil;
364 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
365 Sminibuffer_prompt_end, 0, 0, 0,
366 doc: /* Return the buffer position of the end of the minibuffer prompt.
367 Return (point-min) if current buffer is not a minibuffer. */)
370 /* This function is written to be most efficient when there's a prompt. */
371 Lisp_Object beg, end, tem;
372 beg = make_number (BEGV);
374 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
375 if (NILP (tem))
376 return beg;
378 end = Ffield_end (beg, Qnil, Qnil);
380 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
381 return beg;
382 else
383 return end;
386 DEFUN ("minibuffer-contents", Fminibuffer_contents,
387 Sminibuffer_contents, 0, 0, 0,
388 doc: /* Return the user input in a minibuffer as a string.
389 If the current buffer is not a minibuffer, return its entire contents. */)
392 int prompt_end = XINT (Fminibuffer_prompt_end ());
393 return make_buffer_string (prompt_end, ZV, 1);
396 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
397 Sminibuffer_contents_no_properties, 0, 0, 0,
398 doc: /* Return the user input in a minibuffer as a string, without text-properties.
399 If the current buffer is not a minibuffer, return its entire contents. */)
402 int prompt_end = XINT (Fminibuffer_prompt_end ());
403 return make_buffer_string (prompt_end, ZV, 0);
406 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
407 Sminibuffer_completion_contents, 0, 0, 0,
408 doc: /* Return the user input in a minibuffer before point as a string.
409 That is what completion commands operate on.
410 If the current buffer is not a minibuffer, return its entire contents. */)
413 int prompt_end = XINT (Fminibuffer_prompt_end ());
414 if (PT < prompt_end)
415 error ("Cannot do completion in the prompt");
416 return make_buffer_string (prompt_end, PT, 1);
419 DEFUN ("delete-minibuffer-contents", Fdelete_minibuffer_contents,
420 Sdelete_minibuffer_contents, 0, 0, 0,
421 doc: /* Delete all user input in a minibuffer.
422 If the current buffer is not a minibuffer, erase its entire contents. */)
425 int prompt_end = XINT (Fminibuffer_prompt_end ());
426 if (prompt_end < ZV)
427 del_range (prompt_end, ZV);
428 return Qnil;
432 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
433 putting point minus BACKUP_N bytes from the end of INITIAL,
434 prompting with PROMPT (a string), using history list HISTVAR
435 with initial position HISTPOS. INITIAL should be a string or a
436 cons of a string and an integer. BACKUP_N should be <= 0, or
437 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
438 ignored and replaced with an integer that puts point at one-indexed
439 position N in INITIAL, where N is the CDR of INITIAL, or at the
440 beginning of INITIAL if N <= 0.
442 Normally return the result as a string (the text that was read),
443 but if EXPFLAG is nonzero, read it and return the object read.
444 If HISTVAR is given, save the value read on that history only if it doesn't
445 match the front of that history list exactly. The value is pushed onto
446 the list as the string that was read.
448 DEFALT specifies the default value for the sake of history commands.
450 If ALLOW_PROPS is nonzero, we do not throw away text properties.
452 if INHERIT_INPUT_METHOD is nonzero, the minibuffer inherits the
453 current input method. */
455 static Lisp_Object
456 read_minibuf (map, initial, prompt, backup_n, expflag,
457 histvar, histpos, defalt, allow_props, inherit_input_method)
458 Lisp_Object map;
459 Lisp_Object initial;
460 Lisp_Object prompt;
461 Lisp_Object backup_n;
462 int expflag;
463 Lisp_Object histvar;
464 Lisp_Object histpos;
465 Lisp_Object defalt;
466 int allow_props;
467 int inherit_input_method;
469 Lisp_Object val;
470 int count = SPECPDL_INDEX ();
471 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
472 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
473 Lisp_Object enable_multibyte;
474 int pos = INTEGERP (backup_n) ? XINT (backup_n) : 0;
475 /* String to add to the history. */
476 Lisp_Object histstring;
478 Lisp_Object empty_minibuf;
479 Lisp_Object dummy, frame;
481 extern Lisp_Object Qfront_sticky;
482 extern Lisp_Object Qrear_nonsticky;
484 specbind (Qminibuffer_default, defalt);
486 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
487 in previous recursive minibuffer, but was not set explicitly
488 to t for this invocation, so set it to nil in this minibuffer.
489 Save the old value now, before we change it. */
490 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
491 if (EQ (Vminibuffer_completing_file_name, Qlambda))
492 Vminibuffer_completing_file_name = Qnil;
494 single_kboard_state ();
495 #ifdef HAVE_X_WINDOWS
496 if (display_hourglass_p)
497 cancel_hourglass ();
498 #endif
500 if (!NILP (initial))
502 if (CONSP (initial))
504 backup_n = Fcdr (initial);
505 initial = Fcar (initial);
506 CHECK_STRING (initial);
507 if (!NILP (backup_n))
509 CHECK_NUMBER (backup_n);
510 /* Convert to distance from end of input. */
511 if (XINT (backup_n) < 1)
512 /* A number too small means the beginning of the string. */
513 pos = - SCHARS (initial);
514 else
515 pos = XINT (backup_n) - 1 - SCHARS (initial);
518 else
519 CHECK_STRING (initial);
521 val = Qnil;
522 ambient_dir = current_buffer->directory;
523 input_method = Qnil;
524 enable_multibyte = Qnil;
526 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
527 store them away before we can GC. Don't need to protect
528 BACKUP_N because we use the value only if it is an integer. */
529 GCPRO5 (map, initial, val, ambient_dir, input_method);
531 if (!STRINGP (prompt))
532 prompt = empty_unibyte_string;
534 if (!enable_recursive_minibuffers
535 && minibuf_level > 0)
537 if (EQ (selected_window, minibuf_window))
538 error ("Command attempted to use minibuffer while in minibuffer");
539 else
540 /* If we're in another window, cancel the minibuffer that's active. */
541 Fthrow (Qexit,
542 build_string ("Command attempted to use minibuffer while in minibuffer"));
545 if (noninteractive && NILP (Vexecuting_kbd_macro))
547 val = read_minibuf_noninteractive (map, initial, prompt,
548 make_number (pos),
549 expflag, histvar, histpos, defalt,
550 allow_props, inherit_input_method);
551 UNGCPRO;
552 return unbind_to (count, val);
555 /* Choose the minibuffer window and frame, and take action on them. */
557 choose_minibuf_frame ();
559 record_unwind_protect (choose_minibuf_frame_1, Qnil);
561 record_unwind_protect (Fset_window_configuration,
562 Fcurrent_window_configuration (Qnil));
564 /* If the minibuffer window is on a different frame, save that
565 frame's configuration too. */
566 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
567 if (!EQ (mini_frame, selected_frame))
568 record_unwind_protect (Fset_window_configuration,
569 Fcurrent_window_configuration (mini_frame));
571 /* If the minibuffer is on an iconified or invisible frame,
572 make it visible now. */
573 Fmake_frame_visible (mini_frame);
575 if (minibuffer_auto_raise)
576 Fraise_frame (mini_frame);
578 /* We have to do this after saving the window configuration
579 since that is what restores the current buffer. */
581 /* Arrange to restore a number of minibuffer-related variables.
582 We could bind each variable separately, but that would use lots of
583 specpdl slots. */
584 minibuf_save_list
585 = Fcons (Voverriding_local_map,
586 Fcons (minibuf_window,
587 minibuf_save_list));
588 minibuf_save_list
589 = Fcons (minibuf_prompt,
590 Fcons (make_number (minibuf_prompt_width),
591 Fcons (Vhelp_form,
592 Fcons (Vcurrent_prefix_arg,
593 Fcons (Vminibuffer_history_position,
594 Fcons (Vminibuffer_history_variable,
595 minibuf_save_list))))));
597 record_unwind_protect (read_minibuf_unwind, Qnil);
598 minibuf_level++;
599 /* We are exiting the minibuffer one way or the other, so run the hook.
600 It should be run before unwinding the minibuf settings. Do it
601 separately from read_minibuf_unwind because we need to make sure that
602 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
603 signals an error. --Stef */
604 record_unwind_protect (run_exit_minibuf_hook, Qnil);
606 /* Now that we can restore all those variables, start changing them. */
608 minibuf_prompt_width = 0;
609 minibuf_prompt = Fcopy_sequence (prompt);
610 Vminibuffer_history_position = histpos;
611 Vminibuffer_history_variable = histvar;
612 Vhelp_form = Vminibuffer_help_form;
613 /* If this minibuffer is reading a file name, that doesn't mean
614 recursive ones are. But we cannot set it to nil, because
615 completion code still need to know the minibuffer is completing a
616 file name. So use `lambda' as intermediate value meaning
617 "t" in this minibuffer, but "nil" in next minibuffer. */
618 if (!NILP (Vminibuffer_completing_file_name))
619 Vminibuffer_completing_file_name = Qlambda;
621 if (inherit_input_method)
623 /* `current-input-method' is buffer local. So, remember it in
624 INPUT_METHOD before changing the current buffer. */
625 input_method = Fsymbol_value (Qcurrent_input_method);
626 enable_multibyte = current_buffer->enable_multibyte_characters;
629 /* Switch to the minibuffer. */
631 minibuffer = get_minibuffer (minibuf_level);
632 Fset_buffer (minibuffer);
634 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
635 if (inherit_input_method)
636 current_buffer->enable_multibyte_characters = enable_multibyte;
638 /* The current buffer's default directory is usually the right thing
639 for our minibuffer here. However, if you're typing a command at
640 a minibuffer-only frame when minibuf_level is zero, then buf IS
641 the current_buffer, so reset_buffer leaves buf's default
642 directory unchanged. This is a bummer when you've just started
643 up Emacs and buf's default directory is Qnil. Here's a hack; can
644 you think of something better to do? Find another buffer with a
645 better directory, and use that one instead. */
646 if (STRINGP (ambient_dir))
647 current_buffer->directory = ambient_dir;
648 else
650 Lisp_Object buf_list;
652 for (buf_list = Vbuffer_alist;
653 CONSP (buf_list);
654 buf_list = XCDR (buf_list))
656 Lisp_Object other_buf;
658 other_buf = XCDR (XCAR (buf_list));
659 if (STRINGP (XBUFFER (other_buf)->directory))
661 current_buffer->directory = XBUFFER (other_buf)->directory;
662 break;
667 if (!EQ (mini_frame, selected_frame))
668 Fredirect_frame_focus (selected_frame, mini_frame);
670 Vminibuf_scroll_window = selected_window;
671 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
672 minibuf_selected_window = selected_window;
674 /* Empty out the minibuffers of all frames other than the one
675 where we are going to display one now.
676 Set them to point to ` *Minibuf-0*', which is always empty. */
677 empty_minibuf = Fget_buffer (build_string (" *Minibuf-0*"));
679 FOR_EACH_FRAME (dummy, frame)
681 Lisp_Object root_window = Fframe_root_window (frame);
682 Lisp_Object mini_window = XWINDOW (root_window)->next;
684 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
685 && !NILP (Fwindow_minibuffer_p (mini_window)))
686 Fset_window_buffer (mini_window, empty_minibuf, Qnil);
689 /* Display this minibuffer in the proper window. */
690 Fset_window_buffer (minibuf_window, Fcurrent_buffer (), Qnil);
691 Fselect_window (minibuf_window, Qnil);
692 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
694 Fmake_local_variable (Qprint_escape_newlines);
695 print_escape_newlines = 1;
697 /* Erase the buffer. */
699 int count1 = SPECPDL_INDEX ();
700 specbind (Qinhibit_read_only, Qt);
701 specbind (Qinhibit_modification_hooks, Qt);
702 Ferase_buffer ();
704 if (!NILP (current_buffer->enable_multibyte_characters)
705 && ! STRING_MULTIBYTE (minibuf_prompt))
706 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
708 /* Insert the prompt, record where it ends. */
709 Finsert (1, &minibuf_prompt);
710 if (PT > BEG)
712 Fput_text_property (make_number (BEG), make_number (PT),
713 Qfront_sticky, Qt, Qnil);
714 Fput_text_property (make_number (BEG), make_number (PT),
715 Qrear_nonsticky, Qt, Qnil);
716 Fput_text_property (make_number (BEG), make_number (PT),
717 Qfield, Qt, Qnil);
718 Fadd_text_properties (make_number (BEG), make_number (PT),
719 Vminibuffer_prompt_properties, Qnil);
721 unbind_to (count1, Qnil);
724 minibuf_prompt_width = (int) current_column (); /* iftc */
726 /* Put in the initial input. */
727 if (!NILP (initial))
729 Finsert (1, &initial);
730 Fforward_char (make_number (pos));
733 clear_message (1, 1);
734 current_buffer->keymap = map;
736 /* Turn on an input method stored in INPUT_METHOD if any. */
737 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
738 call1 (Qactivate_input_method, input_method);
740 /* Run our hook, but not if it is empty.
741 (run-hooks would do nothing if it is empty,
742 but it's important to save time here in the usual case.) */
743 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
744 && !NILP (Vrun_hooks))
745 call1 (Vrun_hooks, Qminibuffer_setup_hook);
747 /* Don't allow the user to undo past this point. */
748 current_buffer->undo_list = Qnil;
750 recursive_edit_1 ();
752 /* If cursor is on the minibuffer line,
753 show the user we have exited by putting it in column 0. */
754 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
755 && !noninteractive)
757 XWINDOW (minibuf_window)->cursor.hpos = 0;
758 XWINDOW (minibuf_window)->cursor.x = 0;
759 XWINDOW (minibuf_window)->must_be_updated_p = 1;
760 update_frame (XFRAME (selected_frame), 1, 1);
761 if (rif && rif->flush_display)
762 rif->flush_display (XFRAME (XWINDOW (minibuf_window)->frame));
765 /* Make minibuffer contents into a string. */
766 Fset_buffer (minibuffer);
767 if (allow_props)
768 val = Fminibuffer_contents ();
769 else
770 val = Fminibuffer_contents_no_properties ();
772 /* VAL is the string of minibuffer text. */
774 last_minibuf_string = val;
776 /* Choose the string to add to the history. */
777 if (SCHARS (val) != 0)
778 histstring = val;
779 else if (STRINGP (defalt))
780 histstring = defalt;
781 else
782 histstring = Qnil;
784 /* Add the value to the appropriate history list, if any. */
785 if (!NILP (Vhistory_add_new_input)
786 && SYMBOLP (Vminibuffer_history_variable)
787 && !NILP (histstring))
789 /* If the caller wanted to save the value read on a history list,
790 then do so if the value is not already the front of the list. */
791 Lisp_Object histval;
793 /* If variable is unbound, make it nil. */
794 if (EQ (SYMBOL_VALUE (Vminibuffer_history_variable), Qunbound))
795 Fset (Vminibuffer_history_variable, Qnil);
797 histval = Fsymbol_value (Vminibuffer_history_variable);
799 /* The value of the history variable must be a cons or nil. Other
800 values are unacceptable. We silently ignore these values. */
802 if (NILP (histval)
803 || (CONSP (histval)
804 /* Don't duplicate the most recent entry in the history. */
805 && (NILP (Fequal (histstring, Fcar (histval))))))
807 Lisp_Object length;
809 if (history_delete_duplicates) Fdelete (histstring, histval);
810 histval = Fcons (histstring, histval);
811 Fset (Vminibuffer_history_variable, histval);
813 /* Truncate if requested. */
814 length = Fget (Vminibuffer_history_variable, Qhistory_length);
815 if (NILP (length)) length = Vhistory_length;
816 if (INTEGERP (length))
818 if (XINT (length) <= 0)
819 Fset (Vminibuffer_history_variable, Qnil);
820 else
822 Lisp_Object temp;
824 temp = Fnthcdr (Fsub1 (length), histval);
825 if (CONSP (temp)) Fsetcdr (temp, Qnil);
831 /* If Lisp form desired instead of string, parse it. */
832 if (expflag)
833 val = string_to_object (val, defalt);
835 /* The appropriate frame will get selected
836 in set-window-configuration. */
837 UNGCPRO;
838 return unbind_to (count, val);
841 /* Return a buffer to be used as the minibuffer at depth `depth'.
842 depth = 0 is the lowest allowed argument, and that is the value
843 used for nonrecursive minibuffer invocations */
845 Lisp_Object
846 get_minibuffer (depth)
847 int depth;
849 Lisp_Object tail, num, buf;
850 char name[24];
851 extern Lisp_Object nconc2 ();
853 XSETFASTINT (num, depth);
854 tail = Fnthcdr (num, Vminibuffer_list);
855 if (NILP (tail))
857 tail = Fcons (Qnil, Qnil);
858 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
860 buf = Fcar (tail);
861 if (NILP (buf) || NILP (XBUFFER (buf)->name))
863 sprintf (name, " *Minibuf-%d*", depth);
864 buf = Fget_buffer_create (build_string (name));
866 /* Although the buffer's name starts with a space, undo should be
867 enabled in it. */
868 Fbuffer_enable_undo (buf);
870 XSETCAR (tail, buf);
872 else
874 int count = SPECPDL_INDEX ();
875 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
876 have to empty the list, otherwise we end up with overlays that
877 think they belong to this buffer while the buffer doesn't know about
878 them any more. */
879 delete_all_overlays (XBUFFER (buf));
880 reset_buffer (XBUFFER (buf));
881 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
882 Fset_buffer (buf);
883 Fkill_all_local_variables ();
884 unbind_to (count, Qnil);
887 return buf;
890 static Lisp_Object
891 run_exit_minibuf_hook (data)
892 Lisp_Object data;
894 if (!NILP (Vminibuffer_exit_hook) && !EQ (Vminibuffer_exit_hook, Qunbound)
895 && !NILP (Vrun_hooks))
896 safe_run_hooks (Qminibuffer_exit_hook);
898 return Qnil;
901 /* This function is called on exiting minibuffer, whether normally or
902 not, and it restores the current window, buffer, etc. */
904 static Lisp_Object
905 read_minibuf_unwind (data)
906 Lisp_Object data;
908 Lisp_Object old_deactivate_mark;
909 Lisp_Object window;
911 /* If this was a recursive minibuffer,
912 tie the minibuffer window back to the outer level minibuffer buffer. */
913 minibuf_level--;
915 window = minibuf_window;
916 /* To keep things predictable, in case it matters, let's be in the
917 minibuffer when we reset the relevant variables. */
918 Fset_buffer (XWINDOW (window)->buffer);
920 /* Restore prompt, etc, from outer minibuffer level. */
921 minibuf_prompt = Fcar (minibuf_save_list);
922 minibuf_save_list = Fcdr (minibuf_save_list);
923 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
924 minibuf_save_list = Fcdr (minibuf_save_list);
925 Vhelp_form = Fcar (minibuf_save_list);
926 minibuf_save_list = Fcdr (minibuf_save_list);
927 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
928 minibuf_save_list = Fcdr (minibuf_save_list);
929 Vminibuffer_history_position = Fcar (minibuf_save_list);
930 minibuf_save_list = Fcdr (minibuf_save_list);
931 Vminibuffer_history_variable = Fcar (minibuf_save_list);
932 minibuf_save_list = Fcdr (minibuf_save_list);
933 Voverriding_local_map = Fcar (minibuf_save_list);
934 minibuf_save_list = Fcdr (minibuf_save_list);
935 #if 0
936 temp = Fcar (minibuf_save_list);
937 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
938 minibuf_window = temp;
939 #endif
940 minibuf_save_list = Fcdr (minibuf_save_list);
942 /* Erase the minibuffer we were using at this level. */
944 int count = SPECPDL_INDEX ();
945 /* Prevent error in erase-buffer. */
946 specbind (Qinhibit_read_only, Qt);
947 specbind (Qinhibit_modification_hooks, Qt);
948 old_deactivate_mark = Vdeactivate_mark;
949 Ferase_buffer ();
950 Vdeactivate_mark = old_deactivate_mark;
951 unbind_to (count, Qnil);
954 /* When we get to the outmost level, make sure we resize the
955 mini-window back to its normal size. */
956 if (minibuf_level == 0)
957 resize_mini_window (XWINDOW (window), 0);
959 /* Make sure minibuffer window is erased, not ignored. */
960 windows_or_buffers_changed++;
961 XSETFASTINT (XWINDOW (window)->last_modified, 0);
962 XSETFASTINT (XWINDOW (window)->last_overlay_modified, 0);
963 return Qnil;
967 DEFUN ("read-from-minibuffer", Fread_from_minibuffer, Sread_from_minibuffer, 1, 7, 0,
968 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
969 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
970 DEFAULT-VALUE. It normally should be nil in new code, except when
971 HIST is a cons. It is discussed in more detail below.
972 Third arg KEYMAP is a keymap to use whilst reading;
973 if omitted or nil, the default is `minibuffer-local-map'.
974 If fourth arg READ is non-nil, then interpret the result as a Lisp object
975 and return that object:
976 in other words, do `(car (read-from-string INPUT-STRING))'
977 Fifth arg HIST, if non-nil, specifies a history list and optionally
978 the initial position in the list. It can be a symbol, which is the
979 history list variable to use, or it can be a cons cell
980 (HISTVAR . HISTPOS). In that case, HISTVAR is the history list variable
981 to use, and HISTPOS is the initial position for use by the minibuffer
982 history commands. For consistency, you should also specify that
983 element of the history as the value of INITIAL-CONTENTS. Positions
984 are counted starting from 1 at the beginning of the list.
985 Sixth arg DEFAULT-VALUE is the default value. If non-nil, it is available
986 for history commands; but, unless READ is non-nil, `read-from-minibuffer'
987 does NOT return DEFAULT-VALUE if the user enters empty input! It returns
988 the empty string.
989 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
990 the current input method and the setting of `enable-multibyte-characters'.
991 If the variable `minibuffer-allow-text-properties' is non-nil,
992 then the string which is returned includes whatever text properties
993 were present in the minibuffer. Otherwise the value has no text properties.
995 The remainder of this documentation string describes the
996 INITIAL-CONTENTS argument in more detail. It is only relevant when
997 studying existing code, or when HIST is a cons. If non-nil,
998 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
999 reading input. Normally, point is put at the end of that string.
1000 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
1001 input is STRING, but point is placed at _one-indexed_ position
1002 POSITION in the minibuffer. Any integer value less than or equal to
1003 one puts point at the beginning of the string. *Note* that this
1004 behavior differs from the way such arguments are used in `completing-read'
1005 and some related functions, which use zero-indexing for POSITION. */)
1006 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
1007 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
1008 Lisp_Object inherit_input_method;
1010 Lisp_Object histvar, histpos, val;
1011 struct gcpro gcpro1;
1013 CHECK_STRING (prompt);
1014 if (NILP (keymap))
1015 keymap = Vminibuffer_local_map;
1016 else
1017 keymap = get_keymap (keymap, 1, 0);
1019 if (SYMBOLP (hist))
1021 histvar = hist;
1022 histpos = Qnil;
1024 else
1026 histvar = Fcar_safe (hist);
1027 histpos = Fcdr_safe (hist);
1029 if (NILP (histvar))
1030 histvar = Qminibuffer_history;
1031 if (NILP (histpos))
1032 XSETFASTINT (histpos, 0);
1034 GCPRO1 (default_value);
1035 val = read_minibuf (keymap, initial_contents, prompt,
1036 Qnil, !NILP (read),
1037 histvar, histpos, default_value,
1038 minibuffer_allow_text_properties,
1039 !NILP (inherit_input_method));
1040 UNGCPRO;
1041 return val;
1044 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
1045 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
1046 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1047 is a string to insert in the minibuffer before reading.
1048 \(INITIAL-CONTENTS can also be a cons of a string and an integer. Such
1049 arguments are used as in `read-from-minibuffer'.) */)
1050 (prompt, initial_contents)
1051 Lisp_Object prompt, initial_contents;
1053 CHECK_STRING (prompt);
1054 return read_minibuf (Vminibuffer_local_map, initial_contents,
1055 prompt, Qnil, 1, Qminibuffer_history,
1056 make_number (0), Qnil, 0, 0);
1059 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
1060 doc: /* Return value of Lisp expression read using the minibuffer.
1061 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1062 is a string to insert in the minibuffer before reading.
1063 \(INITIAL-CONTENTS can also be a cons of a string and an integer. Such
1064 arguments are used as in `read-from-minibuffer'.) */)
1065 (prompt, initial_contents)
1066 Lisp_Object prompt, initial_contents;
1068 return Feval (read_minibuf (Vread_expression_map, initial_contents,
1069 prompt, Qnil, 1, Qread_expression_history,
1070 make_number (0), Qnil, 0, 0));
1073 /* Functions that use the minibuffer to read various things. */
1075 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
1076 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
1077 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
1078 This argument has been superseded by DEFAULT-VALUE and should normally
1079 be nil in new code. It behaves as in `read-from-minibuffer'. See the
1080 documentation string of that function for details.
1081 The third arg HISTORY, if non-nil, specifies a history list
1082 and optionally the initial position in the list.
1083 See `read-from-minibuffer' for details of HISTORY argument.
1084 Fourth arg DEFAULT-VALUE is the default value. If non-nil, it is used
1085 for history commands, and as the value to return if the user enters
1086 the empty string.
1087 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1088 the current input method and the setting of `enable-multibyte-characters'. */)
1089 (prompt, initial_input, history, default_value, inherit_input_method)
1090 Lisp_Object prompt, initial_input, history, default_value;
1091 Lisp_Object inherit_input_method;
1093 Lisp_Object val;
1094 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1095 Qnil, history, default_value,
1096 inherit_input_method);
1097 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1098 val = default_value;
1099 return val;
1102 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1103 doc: /* Read a string from the terminal, not allowing blanks.
1104 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1105 non-nil, it should be a string, which is used as initial input, with
1106 point positioned at the end, so that SPACE will accept the input.
1107 \(Actually, INITIAL can also be a cons of a string and an integer.
1108 Such values are treated as in `read-from-minibuffer', but are normally
1109 not useful in this function.)
1110 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1111 the current input method and the setting of`enable-multibyte-characters'. */)
1112 (prompt, initial, inherit_input_method)
1113 Lisp_Object prompt, initial, inherit_input_method;
1115 CHECK_STRING (prompt);
1116 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
1117 0, Qminibuffer_history, make_number (0), Qnil, 0,
1118 !NILP (inherit_input_method));
1121 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1122 doc: /* Read the name of a command and return as a symbol.
1123 Prompt with PROMPT. By default, return DEFAULT-VALUE. */)
1124 (prompt, default_value)
1125 Lisp_Object prompt, default_value;
1127 Lisp_Object name, default_string;
1129 if (NILP (default_value))
1130 default_string = Qnil;
1131 else if (SYMBOLP (default_value))
1132 default_string = SYMBOL_NAME (default_value);
1133 else
1134 default_string = default_value;
1136 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1137 Qnil, Qnil, default_string, Qnil);
1138 if (NILP (name))
1139 return name;
1140 return Fintern (name, Qnil);
1143 #ifdef NOTDEF
1144 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1145 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1146 Prompt with PROMPT. */)
1147 (prompt)
1148 Lisp_Object prompt;
1150 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1151 Qnil);
1153 #endif /* NOTDEF */
1155 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1156 doc: /* Read the name of a user variable and return it as a symbol.
1157 Prompt with PROMPT. By default, return DEFAULT-VALUE.
1158 A user variable is one for which `user-variable-p' returns non-nil. */)
1159 (prompt, default_value)
1160 Lisp_Object prompt, default_value;
1162 Lisp_Object name, default_string;
1164 if (NILP (default_value))
1165 default_string = Qnil;
1166 else if (SYMBOLP (default_value))
1167 default_string = SYMBOL_NAME (default_value);
1168 else
1169 default_string = default_value;
1171 name = Fcompleting_read (prompt, Vobarray,
1172 Quser_variable_p, Qt,
1173 Qnil, Qnil, default_string, Qnil);
1174 if (NILP (name))
1175 return name;
1176 return Fintern (name, Qnil);
1179 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1180 doc: /* Read the name of a buffer and return as a string.
1181 Prompt with PROMPT.
1182 Optional second arg DEF is value to return if user enters an empty line.
1183 If optional third arg REQUIRE-MATCH is non-nil,
1184 only existing buffer names are allowed.
1185 The argument PROMPT should be a string ending with a colon and a space. */)
1186 (prompt, def, require_match)
1187 Lisp_Object prompt, def, require_match;
1189 Lisp_Object args[4];
1190 unsigned char *s;
1191 int len;
1193 if (BUFFERP (def))
1194 def = XBUFFER (def)->name;
1196 if (NILP (Vread_buffer_function))
1198 if (!NILP (def))
1200 /* A default value was provided: we must change PROMPT,
1201 editing the default value in before the colon. To achieve
1202 this, we replace PROMPT with a substring that doesn't
1203 contain the terminal space and colon (if present). They
1204 are then added back using Fformat. */
1206 if (STRINGP (prompt))
1208 s = SDATA (prompt);
1209 len = strlen (s);
1210 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1211 len = len - 2;
1212 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1213 len--;
1215 prompt = make_specified_string (s, -1, len,
1216 STRING_MULTIBYTE (prompt));
1219 args[0] = build_string ("%s (default %s): ");
1220 args[1] = prompt;
1221 args[2] = def;
1222 prompt = Fformat (3, args);
1225 return Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1226 Qnil, require_match, Qnil, Qbuffer_name_history,
1227 def, Qnil);
1229 else
1231 args[0] = Vread_buffer_function;
1232 args[1] = prompt;
1233 args[2] = def;
1234 args[3] = require_match;
1235 return Ffuncall(4, args);
1239 static Lisp_Object
1240 minibuf_conform_representation (string, basis)
1241 Lisp_Object string, basis;
1243 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1244 return string;
1246 if (STRING_MULTIBYTE (string))
1247 return Fstring_make_unibyte (string);
1248 else
1249 return Fstring_make_multibyte (string);
1252 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1253 doc: /* Return common substring of all completions of STRING in COLLECTION.
1254 Test each possible completion specified by COLLECTION
1255 to see if it begins with STRING. The possible completions may be
1256 strings or symbols. Symbols are converted to strings before testing,
1257 see `symbol-name'.
1258 All that match STRING are compared together; the longest initial sequence
1259 common to all these matches is the return value.
1260 If there is no match at all, the return value is nil.
1261 For a unique match which is exact, the return value is t.
1263 If COLLECTION is an alist, the keys (cars of elements) are the
1264 possible completions. If an element is not a cons cell, then the
1265 element itself is the possible completion.
1266 If COLLECTION is a hash-table, all the keys that are strings or symbols
1267 are the possible completions.
1268 If COLLECTION is an obarray, the names of all symbols in the obarray
1269 are the possible completions.
1271 COLLECTION can also be a function to do the completion itself.
1272 It receives three arguments: the values STRING, PREDICATE and nil.
1273 Whatever it returns becomes the value of `try-completion'.
1275 If optional third argument PREDICATE is non-nil,
1276 it is used to test each possible match.
1277 The match is a candidate only if PREDICATE returns non-nil.
1278 The argument given to PREDICATE is the alist element
1279 or the symbol from the obarray. If COLLECTION is a hash-table,
1280 predicate is called with two arguments: the key and the value.
1281 Additionally to this predicate, `completion-regexp-list'
1282 is used to further constrain the set of candidates. */)
1283 (string, collection, predicate)
1284 Lisp_Object string, collection, predicate;
1286 Lisp_Object bestmatch, tail, elt, eltstring;
1287 /* Size in bytes of BESTMATCH. */
1288 int bestmatchsize = 0;
1289 /* These are in bytes, too. */
1290 int compare, matchsize;
1291 int type = (HASH_TABLE_P (collection) ? 3
1292 : VECTORP (collection) ? 2
1293 : NILP (collection) || (CONSP (collection)
1294 && (!SYMBOLP (XCAR (collection))
1295 || NILP (XCAR (collection)))));
1296 int index = 0, obsize = 0;
1297 int matchcount = 0;
1298 int bindcount = -1;
1299 Lisp_Object bucket, zero, end, tem;
1300 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1302 CHECK_STRING (string);
1303 if (type == 0)
1304 return call3 (collection, string, predicate, Qnil);
1306 bestmatch = bucket = Qnil;
1307 zero = make_number (0);
1309 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1310 tail = collection;
1311 if (type == 2)
1313 collection = check_obarray (collection);
1314 obsize = XVECTOR (collection)->size;
1315 bucket = XVECTOR (collection)->contents[index];
1318 while (1)
1320 /* Get the next element of the alist, obarray, or hash-table. */
1321 /* Exit the loop if the elements are all used up. */
1322 /* elt gets the alist element or symbol.
1323 eltstring gets the name to check as a completion. */
1325 if (type == 1)
1327 if (!CONSP (tail))
1328 break;
1329 elt = XCAR (tail);
1330 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1331 tail = XCDR (tail);
1333 else if (type == 2)
1335 if (!EQ (bucket, zero))
1337 if (!SYMBOLP (bucket))
1338 error ("Bad data in guts of obarray");
1339 elt = bucket;
1340 eltstring = elt;
1341 if (XSYMBOL (bucket)->next)
1342 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1343 else
1344 XSETFASTINT (bucket, 0);
1346 else if (++index >= obsize)
1347 break;
1348 else
1350 bucket = XVECTOR (collection)->contents[index];
1351 continue;
1354 else /* if (type == 3) */
1356 while (index < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1357 && NILP (HASH_HASH (XHASH_TABLE (collection), index)))
1358 index++;
1359 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1360 break;
1361 else
1362 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), index++);
1365 /* Is this element a possible completion? */
1367 if (SYMBOLP (eltstring))
1368 eltstring = Fsymbol_name (eltstring);
1370 if (STRINGP (eltstring)
1371 && SCHARS (string) <= SCHARS (eltstring)
1372 && (tem = Fcompare_strings (eltstring, zero,
1373 make_number (SCHARS (string)),
1374 string, zero, Qnil,
1375 completion_ignore_case ? Qt : Qnil),
1376 EQ (Qt, tem)))
1378 /* Yes. */
1379 Lisp_Object regexps;
1381 /* Ignore this element if it fails to match all the regexps. */
1383 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1384 regexps = XCDR (regexps))
1386 if (bindcount < 0) {
1387 bindcount = SPECPDL_INDEX ();
1388 specbind (Qcase_fold_search,
1389 completion_ignore_case ? Qt : Qnil);
1391 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1392 if (NILP (tem))
1393 break;
1395 if (CONSP (regexps))
1396 continue;
1399 /* Ignore this element if there is a predicate
1400 and the predicate doesn't like it. */
1402 if (!NILP (predicate))
1404 if (EQ (predicate, Qcommandp))
1405 tem = Fcommandp (elt, Qnil);
1406 else
1408 if (bindcount >= 0) {
1409 unbind_to (bindcount, Qnil);
1410 bindcount = -1;
1412 GCPRO4 (tail, string, eltstring, bestmatch);
1413 tem = type == 3
1414 ? call2 (predicate, elt,
1415 HASH_VALUE (XHASH_TABLE (collection), index - 1))
1416 : call1 (predicate, elt);
1417 UNGCPRO;
1419 if (NILP (tem)) continue;
1422 /* Update computation of how much all possible completions match */
1424 if (NILP (bestmatch))
1426 matchcount = 1;
1427 bestmatch = eltstring;
1428 bestmatchsize = SCHARS (eltstring);
1430 else
1432 compare = min (bestmatchsize, SCHARS (eltstring));
1433 tem = Fcompare_strings (bestmatch, zero,
1434 make_number (compare),
1435 eltstring, zero,
1436 make_number (compare),
1437 completion_ignore_case ? Qt : Qnil);
1438 if (EQ (tem, Qt))
1439 matchsize = compare;
1440 else if (XINT (tem) < 0)
1441 matchsize = - XINT (tem) - 1;
1442 else
1443 matchsize = XINT (tem) - 1;
1445 if (matchsize < 0)
1446 /* When can this happen ? -stef */
1447 matchsize = compare;
1448 if (completion_ignore_case)
1450 /* If this is an exact match except for case,
1451 use it as the best match rather than one that is not an
1452 exact match. This way, we get the case pattern
1453 of the actual match. */
1454 if ((matchsize == SCHARS (eltstring)
1455 && matchsize < SCHARS (bestmatch))
1457 /* If there is more than one exact match ignoring case,
1458 and one of them is exact including case,
1459 prefer that one. */
1460 /* If there is no exact match ignoring case,
1461 prefer a match that does not change the case
1462 of the input. */
1463 ((matchsize == SCHARS (eltstring))
1465 (matchsize == SCHARS (bestmatch))
1466 && (tem = Fcompare_strings (eltstring, zero,
1467 make_number (SCHARS (string)),
1468 string, zero,
1469 Qnil,
1470 Qnil),
1471 EQ (Qt, tem))
1472 && (tem = Fcompare_strings (bestmatch, zero,
1473 make_number (SCHARS (string)),
1474 string, zero,
1475 Qnil,
1476 Qnil),
1477 ! EQ (Qt, tem))))
1478 bestmatch = eltstring;
1480 if (bestmatchsize != SCHARS (eltstring)
1481 || bestmatchsize != matchsize)
1482 /* Don't count the same string multiple times. */
1483 matchcount++;
1484 bestmatchsize = matchsize;
1485 if (matchsize <= SCHARS (string)
1486 /* If completion-ignore-case is non-nil, don't
1487 short-circuit because we want to find the best
1488 possible match *including* case differences. */
1489 && !completion_ignore_case
1490 && matchcount > 1)
1491 /* No need to look any further. */
1492 break;
1497 if (bindcount >= 0) {
1498 unbind_to (bindcount, Qnil);
1499 bindcount = -1;
1502 if (NILP (bestmatch))
1503 return Qnil; /* No completions found */
1504 /* If we are ignoring case, and there is no exact match,
1505 and no additional text was supplied,
1506 don't change the case of what the user typed. */
1507 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1508 && SCHARS (bestmatch) > bestmatchsize)
1509 return minibuf_conform_representation (string, bestmatch);
1511 /* Return t if the supplied string is an exact match (counting case);
1512 it does not require any change to be made. */
1513 if (matchcount == 1 && bestmatchsize == SCHARS (string)
1514 && (tem = Fcompare_strings (bestmatch, make_number (0),
1515 make_number (bestmatchsize),
1516 string, make_number (0),
1517 make_number (bestmatchsize),
1518 Qnil),
1519 EQ (Qt, tem)))
1520 return Qt;
1522 XSETFASTINT (zero, 0); /* Else extract the part in which */
1523 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1524 return Fsubstring (bestmatch, zero, end);
1527 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1528 doc: /* Search for partial matches to STRING in COLLECTION.
1529 Test each of the possible completions specified by COLLECTION
1530 to see if it begins with STRING. The possible completions may be
1531 strings or symbols. Symbols are converted to strings before testing,
1532 see `symbol-name'.
1533 The value is a list of all the possible completions that match STRING.
1535 If COLLECTION is an alist, the keys (cars of elements) are the
1536 possible completions. If an element is not a cons cell, then the
1537 element itself is the possible completion.
1538 If COLLECTION is a hash-table, all the keys that are strings or symbols
1539 are the possible completions.
1540 If COLLECTION is an obarray, the names of all symbols in the obarray
1541 are the possible completions.
1543 COLLECTION can also be a function to do the completion itself.
1544 It receives three arguments: the values STRING, PREDICATE and t.
1545 Whatever it returns becomes the value of `all-completions'.
1547 If optional third argument PREDICATE is non-nil,
1548 it is used to test each possible match.
1549 The match is a candidate only if PREDICATE returns non-nil.
1550 The argument given to PREDICATE is the alist element
1551 or the symbol from the obarray. If COLLECTION is a hash-table,
1552 predicate is called with two arguments: the key and the value.
1553 Additionally to this predicate, `completion-regexp-list'
1554 is used to further constrain the set of candidates.
1556 If the optional fourth argument HIDE-SPACES is non-nil,
1557 strings in COLLECTION that start with a space
1558 are ignored unless STRING itself starts with a space. */)
1559 (string, collection, predicate, hide_spaces)
1560 Lisp_Object string, collection, predicate, hide_spaces;
1562 Lisp_Object tail, elt, eltstring;
1563 Lisp_Object allmatches;
1564 int type = HASH_TABLE_P (collection) ? 3
1565 : VECTORP (collection) ? 2
1566 : NILP (collection) || (CONSP (collection)
1567 && (!SYMBOLP (XCAR (collection))
1568 || NILP (XCAR (collection))));
1569 int index = 0, obsize = 0;
1570 int bindcount = -1;
1571 Lisp_Object bucket, tem, zero;
1572 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1574 CHECK_STRING (string);
1575 if (type == 0)
1576 return call3 (collection, string, predicate, Qt);
1577 allmatches = bucket = Qnil;
1578 zero = make_number (0);
1580 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1581 tail = collection;
1582 if (type == 2)
1584 obsize = XVECTOR (collection)->size;
1585 bucket = XVECTOR (collection)->contents[index];
1588 while (1)
1590 /* Get the next element of the alist, obarray, or hash-table. */
1591 /* Exit the loop if the elements are all used up. */
1592 /* elt gets the alist element or symbol.
1593 eltstring gets the name to check as a completion. */
1595 if (type == 1)
1597 if (!CONSP (tail))
1598 break;
1599 elt = XCAR (tail);
1600 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1601 tail = XCDR (tail);
1603 else if (type == 2)
1605 if (!EQ (bucket, zero))
1607 elt = bucket;
1608 eltstring = elt;
1609 if (XSYMBOL (bucket)->next)
1610 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1611 else
1612 XSETFASTINT (bucket, 0);
1614 else if (++index >= obsize)
1615 break;
1616 else
1618 bucket = XVECTOR (collection)->contents[index];
1619 continue;
1622 else /* if (type == 3) */
1624 while (index < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1625 && NILP (HASH_HASH (XHASH_TABLE (collection), index)))
1626 index++;
1627 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1628 break;
1629 else
1630 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), index++);
1633 /* Is this element a possible completion? */
1635 if (SYMBOLP (eltstring))
1636 eltstring = Fsymbol_name (eltstring);
1638 if (STRINGP (eltstring)
1639 && SCHARS (string) <= SCHARS (eltstring)
1640 /* If HIDE_SPACES, reject alternatives that start with space
1641 unless the input starts with space. */
1642 && ((SBYTES (string) > 0
1643 && SREF (string, 0) == ' ')
1644 || SREF (eltstring, 0) != ' '
1645 || NILP (hide_spaces))
1646 && (tem = Fcompare_strings (eltstring, zero,
1647 make_number (SCHARS (string)),
1648 string, zero,
1649 make_number (SCHARS (string)),
1650 completion_ignore_case ? Qt : Qnil),
1651 EQ (Qt, tem)))
1653 /* Yes. */
1654 Lisp_Object regexps;
1655 Lisp_Object zero;
1656 XSETFASTINT (zero, 0);
1658 /* Ignore this element if it fails to match all the regexps. */
1660 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1661 regexps = XCDR (regexps))
1663 if (bindcount < 0) {
1664 bindcount = SPECPDL_INDEX ();
1665 specbind (Qcase_fold_search,
1666 completion_ignore_case ? Qt : Qnil);
1668 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1669 if (NILP (tem))
1670 break;
1672 if (CONSP (regexps))
1673 continue;
1676 /* Ignore this element if there is a predicate
1677 and the predicate doesn't like it. */
1679 if (!NILP (predicate))
1681 if (EQ (predicate, Qcommandp))
1682 tem = Fcommandp (elt, Qnil);
1683 else
1685 if (bindcount >= 0) {
1686 unbind_to (bindcount, Qnil);
1687 bindcount = -1;
1689 GCPRO4 (tail, eltstring, allmatches, string);
1690 tem = type == 3
1691 ? call2 (predicate, elt,
1692 HASH_VALUE (XHASH_TABLE (collection), index - 1))
1693 : call1 (predicate, elt);
1694 UNGCPRO;
1696 if (NILP (tem)) continue;
1698 /* Ok => put it on the list. */
1699 allmatches = Fcons (eltstring, allmatches);
1703 if (bindcount >= 0) {
1704 unbind_to (bindcount, Qnil);
1705 bindcount = -1;
1708 return Fnreverse (allmatches);
1711 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1712 doc: /* Read a string in the minibuffer, with completion.
1713 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1714 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1715 COLLECTION can also be a function to do the completion itself.
1716 PREDICATE limits completion to a subset of COLLECTION.
1717 See `try-completion' and `all-completions' for more details
1718 on completion, COLLECTION, and PREDICATE.
1720 REQUIRE-MATCH can take the following values:
1721 - t means that the user is not allowed to exit unless
1722 the input is (or completes to) an element of COLLECTION or is null.
1723 - nil means that the user can exit with any input.
1724 - `confirm-only' means that the user can exit with any input, but she will
1725 need to confirm her choice if the input is not an element of COLLECTION.
1726 - anything else behaves like t except that typing RET does not exit if it
1727 does non-null completion.
1729 If the input is null, `completing-read' returns DEF, or an empty string
1730 if DEF is nil, regardless of the value of REQUIRE-MATCH.
1732 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1733 with point positioned at the end.
1734 If it is (STRING . POSITION), the initial input is STRING, but point
1735 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1736 that this is different from `read-from-minibuffer' and related
1737 functions, which use one-indexing for POSITION.) This feature is
1738 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1739 default value DEF instead. The user can yank the default value into
1740 the minibuffer easily using \\[next-history-element].
1742 HIST, if non-nil, specifies a history list and optionally the initial
1743 position in the list. It can be a symbol, which is the history list
1744 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1745 that case, HISTVAR is the history list variable to use, and HISTPOS
1746 is the initial position (the position in the list used by the
1747 minibuffer history commands). For consistency, you should also
1748 specify that element of the history as the value of
1749 INITIAL-INPUT. (This is the only case in which you should use
1750 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1751 1 at the beginning of the list. The variable `history-length'
1752 controls the maximum length of a history list.
1754 DEF, if non-nil, is the default value.
1756 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1757 the current input method and the setting of `enable-multibyte-characters'.
1759 Completion ignores case if the ambient value of
1760 `completion-ignore-case' is non-nil. */)
1761 (prompt, collection, predicate, require_match, initial_input, hist, def, inherit_input_method)
1762 Lisp_Object prompt, collection, predicate, require_match, initial_input;
1763 Lisp_Object hist, def, inherit_input_method;
1765 Lisp_Object val, histvar, histpos, position;
1766 Lisp_Object init;
1767 int pos = 0;
1768 int count = SPECPDL_INDEX ();
1769 struct gcpro gcpro1;
1771 init = initial_input;
1772 GCPRO1 (def);
1774 specbind (Qminibuffer_completion_table, collection);
1775 specbind (Qminibuffer_completion_predicate, predicate);
1776 specbind (Qminibuffer_completion_confirm,
1777 EQ (require_match, Qt) ? Qnil : require_match);
1778 last_exact_completion = Qnil;
1780 position = Qnil;
1781 if (!NILP (init))
1783 if (CONSP (init))
1785 position = Fcdr (init);
1786 init = Fcar (init);
1788 CHECK_STRING (init);
1789 if (!NILP (position))
1791 CHECK_NUMBER (position);
1792 /* Convert to distance from end of input. */
1793 pos = XINT (position) - SCHARS (init);
1797 if (SYMBOLP (hist))
1799 histvar = hist;
1800 histpos = Qnil;
1802 else
1804 histvar = Fcar_safe (hist);
1805 histpos = Fcdr_safe (hist);
1807 if (NILP (histvar))
1808 histvar = Qminibuffer_history;
1809 if (NILP (histpos))
1810 XSETFASTINT (histpos, 0);
1812 val = read_minibuf (NILP (require_match)
1813 ? (NILP (Vminibuffer_completing_file_name)
1814 || EQ (Vminibuffer_completing_file_name, Qlambda)
1815 ? Vminibuffer_local_completion_map
1816 : Vminibuffer_local_filename_completion_map)
1817 : (NILP (Vminibuffer_completing_file_name)
1818 || EQ (Vminibuffer_completing_file_name, Qlambda)
1819 ? Vminibuffer_local_must_match_map
1820 : Vminibuffer_local_must_match_filename_map),
1821 init, prompt, make_number (pos), 0,
1822 histvar, histpos, def, 0,
1823 !NILP (inherit_input_method));
1825 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
1826 val = def;
1828 RETURN_UNGCPRO (unbind_to (count, val));
1831 Lisp_Object Fminibuffer_completion_help ();
1832 Lisp_Object Fassoc_string ();
1834 /* Test whether TXT is an exact completion. */
1835 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1836 doc: /* Return non-nil if STRING is a valid completion.
1837 Takes the same arguments as `all-completions' and `try-completion'.
1838 If COLLECTION is a function, it is called with three arguments:
1839 the values STRING, PREDICATE and `lambda'. */)
1840 (string, collection, predicate)
1841 Lisp_Object string, collection, predicate;
1843 Lisp_Object regexps, tail, tem = Qnil;
1844 int i = 0;
1846 CHECK_STRING (string);
1848 if ((CONSP (collection)
1849 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1850 || NILP (collection))
1852 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1853 if (NILP (tem))
1854 return Qnil;
1856 else if (VECTORP (collection))
1858 /* Bypass intern-soft as that loses for nil. */
1859 tem = oblookup (collection,
1860 SDATA (string),
1861 SCHARS (string),
1862 SBYTES (string));
1863 if (!SYMBOLP (tem))
1865 if (STRING_MULTIBYTE (string))
1866 string = Fstring_make_unibyte (string);
1867 else
1868 string = Fstring_make_multibyte (string);
1870 tem = oblookup (collection,
1871 SDATA (string),
1872 SCHARS (string),
1873 SBYTES (string));
1876 if (completion_ignore_case && !SYMBOLP (tem))
1878 for (i = XVECTOR (collection)->size - 1; i >= 0; i--)
1880 tail = XVECTOR (collection)->contents[i];
1881 if (SYMBOLP (tail))
1882 while (1)
1884 if (EQ((Fcompare_strings (string, make_number (0), Qnil,
1885 Fsymbol_name (tail),
1886 make_number (0) , Qnil, Qt)),
1887 Qt))
1889 tem = tail;
1890 break;
1892 if (XSYMBOL (tail)->next == 0)
1893 break;
1894 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1899 if (!SYMBOLP (tem))
1900 return Qnil;
1902 else if (HASH_TABLE_P (collection))
1904 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1905 i = hash_lookup (h, string, NULL);
1906 if (i >= 0)
1907 tem = HASH_KEY (h, i);
1908 else
1909 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1910 if (!NILP (HASH_HASH (h, i)) &&
1911 EQ (Fcompare_strings (string, make_number (0), Qnil,
1912 HASH_KEY (h, i), make_number (0) , Qnil,
1913 completion_ignore_case ? Qt : Qnil),
1914 Qt))
1916 tem = HASH_KEY (h, i);
1917 break;
1919 if (!STRINGP (tem))
1920 return Qnil;
1922 else
1923 return call3 (collection, string, predicate, Qlambda);
1925 /* Reject this element if it fails to match all the regexps. */
1926 if (CONSP (Vcompletion_regexp_list))
1928 int count = SPECPDL_INDEX ();
1929 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1930 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1931 regexps = XCDR (regexps))
1933 if (NILP (Fstring_match (XCAR (regexps),
1934 SYMBOLP (tem) ? string : tem,
1935 Qnil)))
1936 return unbind_to (count, Qnil);
1938 unbind_to (count, Qnil);
1941 /* Finally, check the predicate. */
1942 if (!NILP (predicate))
1944 return HASH_TABLE_P (collection)
1945 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1946 : call1 (predicate, tem);
1948 else
1949 return Qt;
1952 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1953 doc: /* Perform completion on buffer names.
1954 If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1955 `all-completions', otherwise invoke `test-completion'.
1957 The arguments STRING and PREDICATE are as in `try-completion',
1958 `all-completions', and `test-completion'. */)
1959 (string, predicate, flag)
1960 Lisp_Object string, predicate, flag;
1962 if (NILP (flag))
1963 return Ftry_completion (string, Vbuffer_alist, predicate);
1964 else if (EQ (flag, Qt))
1965 return Fall_completions (string, Vbuffer_alist, predicate, Qt);
1966 else /* assume `lambda' */
1967 return Ftest_completion (string, Vbuffer_alist, predicate);
1970 /* returns:
1971 * 0 no possible completion
1972 * 1 was already an exact and unique completion
1973 * 3 was already an exact completion
1974 * 4 completed to an exact completion
1975 * 5 some completion happened
1976 * 6 no completion happened
1979 do_completion ()
1981 Lisp_Object completion, string, tem;
1982 int completedp;
1983 Lisp_Object last;
1984 struct gcpro gcpro1, gcpro2;
1986 completion = Ftry_completion (Fminibuffer_completion_contents (),
1987 Vminibuffer_completion_table,
1988 Vminibuffer_completion_predicate);
1989 last = last_exact_completion;
1990 last_exact_completion = Qnil;
1992 GCPRO2 (completion, last);
1994 if (NILP (completion))
1996 bitch_at_user ();
1997 temp_echo_area_glyphs (build_string (" [No match]"));
1998 UNGCPRO;
1999 return 0;
2002 if (EQ (completion, Qt)) /* exact and unique match */
2004 UNGCPRO;
2005 return 1;
2008 string = Fminibuffer_completion_contents ();
2010 /* COMPLETEDP should be true if some completion was done, which
2011 doesn't include simply changing the case of the entered string.
2012 However, for appearance, the string is rewritten if the case
2013 changes. */
2014 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qt);
2015 completedp = !EQ (tem, Qt);
2017 tem = Fcompare_strings (completion, Qnil, Qnil, string, Qnil, Qnil, Qnil);
2018 if (!EQ (tem, Qt))
2019 /* Rewrite the user's input. */
2021 int prompt_end = XINT (Fminibuffer_prompt_end ());
2022 /* Some completion happened */
2024 if (! NILP (Vminibuffer_completing_file_name)
2025 && SREF (completion, SBYTES (completion) - 1) == '/'
2026 && PT < ZV
2027 && FETCH_CHAR (PT_BYTE) == '/')
2029 del_range (prompt_end, PT + 1);
2031 else
2032 del_range (prompt_end, PT);
2034 Finsert (1, &completion);
2036 if (! completedp)
2037 /* The case of the string changed, but that's all. We're not
2038 sure whether this is a unique completion or not, so try again
2039 using the real case (this shouldn't recurse again, because
2040 the next time try-completion will return either `t' or the
2041 exact string). */
2043 UNGCPRO;
2044 return do_completion ();
2048 /* It did find a match. Do we match some possibility exactly now? */
2049 tem = Ftest_completion (Fminibuffer_contents (),
2050 Vminibuffer_completion_table,
2051 Vminibuffer_completion_predicate);
2052 if (NILP (tem))
2054 /* not an exact match */
2055 UNGCPRO;
2056 if (completedp)
2057 return 5;
2058 else if (!NILP (Vcompletion_auto_help))
2059 Fminibuffer_completion_help ();
2060 else
2061 temp_echo_area_glyphs (build_string (" [Next char not unique]"));
2062 return 6;
2064 else if (completedp)
2066 UNGCPRO;
2067 return 4;
2069 /* If the last exact completion and this one were the same,
2070 it means we've already given a "Complete but not unique"
2071 message and the user's hit TAB again, so now we give him help. */
2072 last_exact_completion = completion;
2073 if (!NILP (last))
2075 tem = Fminibuffer_completion_contents ();
2076 if (!NILP (Fequal (tem, last)))
2077 Fminibuffer_completion_help ();
2079 UNGCPRO;
2080 return 3;
2083 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
2085 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
2086 doc: /* Like `assoc' but specifically for strings (and symbols).
2087 Symbols are converted to strings, and unibyte strings are converted to
2088 multibyte for comparison.
2089 Case is ignored if optional arg CASE-FOLD is non-nil.
2090 As opposed to `assoc', it will also match an entry consisting of a single
2091 string rather than a cons cell whose car is a string. */)
2092 (key, list, case_fold)
2093 register Lisp_Object key;
2094 Lisp_Object list, case_fold;
2096 register Lisp_Object tail;
2098 if (SYMBOLP (key))
2099 key = Fsymbol_name (key);
2101 for (tail = list; !NILP (tail); tail = Fcdr (tail))
2103 register Lisp_Object elt, tem, thiscar;
2104 elt = Fcar (tail);
2105 thiscar = CONSP (elt) ? XCAR (elt) : elt;
2106 if (SYMBOLP (thiscar))
2107 thiscar = Fsymbol_name (thiscar);
2108 else if (!STRINGP (thiscar))
2109 continue;
2110 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
2111 key, make_number (0), Qnil,
2112 case_fold);
2113 if (EQ (tem, Qt))
2114 return elt;
2115 QUIT;
2117 return Qnil;
2120 DEFUN ("minibuffer-complete", Fminibuffer_complete, Sminibuffer_complete, 0, 0, "",
2121 doc: /* Complete the minibuffer contents as far as possible.
2122 Return nil if there is no valid completion, else t.
2123 If no characters can be completed, display a list of possible completions.
2124 If you repeat this command after it displayed such a list,
2125 scroll the window of possible completions. */)
2128 register int i;
2129 Lisp_Object window, tem;
2131 /* If the previous command was not this,
2132 mark the completion buffer obsolete. */
2133 if (! EQ (current_kboard->Vlast_command, Vthis_command))
2134 Vminibuf_scroll_window = Qnil;
2136 window = Vminibuf_scroll_window;
2137 /* If there's a fresh completion window with a live buffer,
2138 and this command is repeated, scroll that window. */
2139 if (! NILP (window) && ! NILP (XWINDOW (window)->buffer)
2140 && !NILP (XBUFFER (XWINDOW (window)->buffer)->name))
2142 struct buffer *obuf = current_buffer;
2144 Fset_buffer (XWINDOW (window)->buffer);
2145 tem = Fpos_visible_in_window_p (make_number (ZV), window, Qnil);
2146 if (! NILP (tem))
2147 /* If end is in view, scroll up to the beginning. */
2148 Fset_window_start (window, make_number (BEGV), Qnil);
2149 else
2150 /* Else scroll down one screen. */
2151 Fscroll_other_window (Qnil);
2153 set_buffer_internal (obuf);
2154 return Qnil;
2157 i = do_completion ();
2158 switch (i)
2160 case 0:
2161 return Qnil;
2163 case 1:
2164 if (PT != ZV)
2165 Fgoto_char (make_number (ZV));
2166 temp_echo_area_glyphs (build_string (" [Sole completion]"));
2167 break;
2169 case 3:
2170 if (PT != ZV)
2171 Fgoto_char (make_number (ZV));
2172 temp_echo_area_glyphs (build_string (" [Complete, but not unique]"));
2173 break;
2176 return Qt;
2179 /* Subroutines of Fminibuffer_complete_and_exit. */
2181 /* This one is called by internal_condition_case to do the real work. */
2183 Lisp_Object
2184 complete_and_exit_1 ()
2186 return make_number (do_completion ());
2189 /* This one is called by internal_condition_case if an error happens.
2190 Pretend the current value is an exact match. */
2192 Lisp_Object
2193 complete_and_exit_2 (ignore)
2194 Lisp_Object ignore;
2196 return make_number (1);
2199 EXFUN (Fexit_minibuffer, 0) NO_RETURN;
2201 DEFUN ("minibuffer-complete-and-exit", Fminibuffer_complete_and_exit,
2202 Sminibuffer_complete_and_exit, 0, 0, "",
2203 doc: /* If the minibuffer contents is a valid completion then exit.
2204 Otherwise try to complete it. If completion leads to a valid completion,
2205 a repetition of this command will exit. */)
2208 register int i;
2209 Lisp_Object val, tem;
2211 /* Allow user to specify null string */
2212 if (XINT (Fminibuffer_prompt_end ()) == ZV)
2213 goto exit;
2215 val = Fminibuffer_contents ();
2216 tem = Ftest_completion (val,
2217 Vminibuffer_completion_table,
2218 Vminibuffer_completion_predicate);
2219 if (!NILP (tem))
2221 if (completion_ignore_case)
2222 { /* Fixup case of the field, if necessary. */
2223 Lisp_Object compl
2224 = Ftry_completion (val,
2225 Vminibuffer_completion_table,
2226 Vminibuffer_completion_predicate);
2227 if (STRINGP (compl)
2228 /* If it weren't for this piece of paranoia, I'd replace
2229 the whole thing with a call to do_completion. */
2230 && EQ (Flength (val), Flength (compl)))
2232 del_range (XINT (Fminibuffer_prompt_end ()), ZV);
2233 Finsert (1, &compl);
2236 goto exit;
2239 if (EQ (Vminibuffer_completion_confirm, intern ("confirm-only")))
2240 { /* The user is permitted to exit with an input that's rejected
2241 by test-completion, but at the condition to confirm her choice. */
2242 if (EQ (current_kboard->Vlast_command, Vthis_command))
2243 goto exit;
2244 else
2246 temp_echo_area_glyphs (build_string (" [Confirm]"));
2247 return Qnil;
2251 /* Call do_completion, but ignore errors. */
2252 SET_PT (ZV);
2253 val = internal_condition_case (complete_and_exit_1, Qerror,
2254 complete_and_exit_2);
2256 i = XFASTINT (val);
2257 switch (i)
2259 case 1:
2260 case 3:
2261 goto exit;
2263 case 4:
2264 if (!NILP (Vminibuffer_completion_confirm))
2266 temp_echo_area_glyphs (build_string (" [Confirm]"));
2267 return Qnil;
2269 else
2270 goto exit;
2272 default:
2273 return Qnil;
2275 exit:
2276 return Fexit_minibuffer ();
2277 /* NOTREACHED */
2280 DEFUN ("minibuffer-complete-word", Fminibuffer_complete_word, Sminibuffer_complete_word,
2281 0, 0, "",
2282 doc: /* Complete the minibuffer contents at most a single word.
2283 After one word is completed as much as possible, a space or hyphen
2284 is added, provided that matches some possible completion.
2285 Return nil if there is no valid completion, else t. */)
2288 Lisp_Object completion, tem, tem1;
2289 register int i, i_byte;
2290 struct gcpro gcpro1, gcpro2;
2291 int prompt_end_charpos = XINT (Fminibuffer_prompt_end ());
2293 /* We keep calling Fbuffer_string rather than arrange for GC to
2294 hold onto a pointer to one of the strings thus made. */
2296 completion = Ftry_completion (Fminibuffer_completion_contents (),
2297 Vminibuffer_completion_table,
2298 Vminibuffer_completion_predicate);
2299 if (NILP (completion))
2301 bitch_at_user ();
2302 temp_echo_area_glyphs (build_string (" [No match]"));
2303 return Qnil;
2305 if (EQ (completion, Qt))
2306 return Qnil;
2308 #if 0 /* How the below code used to look, for reference. */
2309 tem = Fminibuffer_contents ();
2310 b = SDATA (tem);
2311 i = ZV - 1 - SCHARS (completion);
2312 p = SDATA (completion);
2313 if (i > 0 ||
2314 0 <= scmp (b, p, ZV - 1))
2316 i = 1;
2317 /* Set buffer to longest match of buffer tail and completion head. */
2318 while (0 <= scmp (b + i, p, ZV - 1 - i))
2319 i++;
2320 del_range (1, i + 1);
2321 SET_PT (ZV);
2323 #else /* Rewritten code */
2325 int buffer_nchars, completion_nchars;
2327 CHECK_STRING (completion);
2328 tem = Fminibuffer_completion_contents ();
2329 GCPRO2 (completion, tem);
2330 /* If reading a file name,
2331 expand any $ENVVAR refs in the buffer and in TEM. */
2332 if (! NILP (Vminibuffer_completing_file_name))
2334 Lisp_Object substituted;
2335 substituted = Fsubstitute_in_file_name (tem);
2336 if (! EQ (substituted, tem))
2338 tem = substituted;
2339 del_range (prompt_end_charpos, PT);
2340 Finsert (1, &tem);
2343 buffer_nchars = SCHARS (tem); /* # chars in what we completed. */
2344 completion_nchars = SCHARS (completion);
2345 i = buffer_nchars - completion_nchars;
2346 if (i > 0
2348 (tem1 = Fcompare_strings (tem, make_number (0),
2349 make_number (buffer_nchars),
2350 completion, make_number (0),
2351 make_number (buffer_nchars),
2352 completion_ignore_case ? Qt : Qnil),
2353 ! EQ (tem1, Qt)))
2355 int start_pos;
2357 /* Make buffer (before point) contain the longest match
2358 of TEM's tail and COMPLETION's head. */
2359 if (i <= 0) i = 1;
2360 start_pos= i;
2361 buffer_nchars -= i;
2362 while (i > 0)
2364 tem1 = Fcompare_strings (tem, make_number (start_pos), Qnil,
2365 completion, make_number (0),
2366 make_number (buffer_nchars),
2367 completion_ignore_case ? Qt : Qnil);
2368 start_pos++;
2369 if (EQ (tem1, Qt))
2370 break;
2371 i++;
2372 buffer_nchars--;
2374 del_range (start_pos, start_pos + buffer_nchars);
2376 UNGCPRO;
2378 #endif /* Rewritten code */
2381 int prompt_end_bytepos;
2382 prompt_end_bytepos = CHAR_TO_BYTE (prompt_end_charpos);
2383 i = PT - prompt_end_charpos;
2384 i_byte = PT_BYTE - prompt_end_bytepos;
2387 /* If completion finds next char not unique,
2388 consider adding a space or a hyphen. */
2389 if (i == SCHARS (completion))
2391 GCPRO1 (completion);
2392 tem = Ftry_completion (concat2 (Fminibuffer_completion_contents (),
2393 build_string (" ")),
2394 Vminibuffer_completion_table,
2395 Vminibuffer_completion_predicate);
2396 UNGCPRO;
2398 if (STRINGP (tem))
2399 completion = tem;
2400 else
2402 GCPRO1 (completion);
2403 tem =
2404 Ftry_completion (concat2 (Fminibuffer_completion_contents (),
2405 build_string ("-")),
2406 Vminibuffer_completion_table,
2407 Vminibuffer_completion_predicate);
2408 UNGCPRO;
2410 if (STRINGP (tem))
2411 completion = tem;
2415 /* Now find first word-break in the stuff found by completion.
2416 i gets index in string of where to stop completing. */
2418 int len, c;
2419 int bytes = SBYTES (completion);
2420 register const unsigned char *completion_string = SDATA (completion);
2421 for (; i_byte < SBYTES (completion); i_byte += len, i++)
2423 c = STRING_CHAR_AND_LENGTH (completion_string + i_byte,
2424 bytes - i_byte,
2425 len);
2426 if (SYNTAX (c) != Sword)
2428 i_byte += len;
2429 i++;
2430 break;
2435 /* If got no characters, print help for user. */
2437 if (i == PT - prompt_end_charpos)
2439 if (!NILP (Vcompletion_auto_help))
2440 Fminibuffer_completion_help ();
2441 return Qnil;
2444 /* Otherwise insert in minibuffer the chars we got */
2446 if (! NILP (Vminibuffer_completing_file_name)
2447 && SREF (completion, SBYTES (completion) - 1) == '/'
2448 && PT < ZV
2449 && FETCH_CHAR (PT_BYTE) == '/')
2451 del_range (prompt_end_charpos, PT + 1);
2453 else
2454 del_range (prompt_end_charpos, PT);
2456 insert_from_string (completion, 0, 0, i, i_byte, 1);
2457 return Qt;
2460 DEFUN ("display-completion-list", Fdisplay_completion_list, Sdisplay_completion_list,
2461 1, 2, 0,
2462 doc: /* Display the list of completions, COMPLETIONS, using `standard-output'.
2463 Each element may be just a symbol or string
2464 or may be a list of two strings to be printed as if concatenated.
2465 If it is a list of two strings, the first is the actual completion
2466 alternative, the second serves as annotation.
2467 `standard-output' must be a buffer.
2468 The actual completion alternatives, as inserted, are given `mouse-face'
2469 properties of `highlight'.
2470 At the end, this runs the normal hook `completion-setup-hook'.
2471 It can find the completion buffer in `standard-output'.
2472 The optional second arg COMMON-SUBSTRING is a string.
2473 It is used to put faces, `completions-first-difference' and
2474 `completions-common-part' on the completion buffer. The
2475 `completions-common-part' face is put on the common substring
2476 specified by COMMON-SUBSTRING. If COMMON-SUBSTRING is nil
2477 and the current buffer is not the minibuffer, the faces are not put.
2478 Internally, COMMON-SUBSTRING is bound to `completion-common-substring'
2479 during running `completion-setup-hook'. */)
2480 (completions, common_substring)
2481 Lisp_Object completions;
2482 Lisp_Object common_substring;
2484 Lisp_Object tail, elt;
2485 register int i;
2486 int column = 0;
2487 struct gcpro gcpro1, gcpro2, gcpro3;
2488 struct buffer *old = current_buffer;
2489 int first = 1;
2491 /* Note that (when it matters) every variable
2492 points to a non-string that is pointed to by COMPLETIONS,
2493 except for ELT. ELT can be pointing to a string
2494 when terpri or Findent_to calls a change hook. */
2495 elt = Qnil;
2496 GCPRO3 (completions, elt, common_substring);
2498 if (BUFFERP (Vstandard_output))
2499 set_buffer_internal (XBUFFER (Vstandard_output));
2501 if (NILP (completions))
2502 write_string ("There are no possible completions of what you have typed.",
2503 -1);
2504 else
2506 write_string ("Possible completions are:", -1);
2507 for (tail = completions, i = 0; CONSP (tail); tail = XCDR (tail), i++)
2509 Lisp_Object tem, string;
2510 int length;
2511 Lisp_Object startpos, endpos;
2513 startpos = Qnil;
2515 elt = XCAR (tail);
2516 if (SYMBOLP (elt))
2517 elt = SYMBOL_NAME (elt);
2518 /* Compute the length of this element. */
2519 if (CONSP (elt))
2521 tem = XCAR (elt);
2522 CHECK_STRING (tem);
2523 length = SCHARS (tem);
2525 tem = Fcar (XCDR (elt));
2526 CHECK_STRING (tem);
2527 length += SCHARS (tem);
2529 else
2531 CHECK_STRING (elt);
2532 length = SCHARS (elt);
2535 /* This does a bad job for narrower than usual windows.
2536 Sadly, the window it will appear in is not known
2537 until after the text has been made. */
2539 if (BUFFERP (Vstandard_output))
2540 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2542 /* If the previous completion was very wide,
2543 or we have two on this line already,
2544 don't put another on the same line. */
2545 if (column > 33 || first
2546 /* If this is really wide, don't put it second on a line. */
2547 || (column > 0 && length > 45))
2549 Fterpri (Qnil);
2550 column = 0;
2552 /* Otherwise advance to column 35. */
2553 else
2555 if (BUFFERP (Vstandard_output))
2557 tem = Findent_to (make_number (35), make_number (2));
2559 column = XINT (tem);
2561 else
2565 write_string (" ", -1);
2566 column++;
2568 while (column < 35);
2572 if (BUFFERP (Vstandard_output))
2574 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2575 Fset_text_properties (startpos, endpos,
2576 Qnil, Vstandard_output);
2579 /* Output this element.
2580 If necessary, convert it to unibyte or to multibyte first. */
2581 if (CONSP (elt))
2582 string = Fcar (elt);
2583 else
2584 string = elt;
2585 if (NILP (current_buffer->enable_multibyte_characters)
2586 && STRING_MULTIBYTE (string))
2587 string = Fstring_make_unibyte (string);
2588 else if (!NILP (current_buffer->enable_multibyte_characters)
2589 && !STRING_MULTIBYTE (string))
2590 string = Fstring_make_multibyte (string);
2592 if (BUFFERP (Vstandard_output))
2594 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2596 Fprinc (string, Qnil);
2598 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2600 Fput_text_property (startpos, endpos,
2601 Qmouse_face, intern ("highlight"),
2602 Vstandard_output);
2604 else
2606 Fprinc (string, Qnil);
2609 /* Output the annotation for this element. */
2610 if (CONSP (elt))
2612 if (BUFFERP (Vstandard_output))
2614 XSETINT (startpos, BUF_PT (XBUFFER (Vstandard_output)));
2616 Fprinc (Fcar (Fcdr (elt)), Qnil);
2618 XSETINT (endpos, BUF_PT (XBUFFER (Vstandard_output)));
2620 Fset_text_properties (startpos, endpos, Qnil,
2621 Vstandard_output);
2623 else
2625 Fprinc (Fcar (Fcdr (elt)), Qnil);
2630 /* Update COLUMN for what we have output. */
2631 column += length;
2633 /* If output is to a buffer, recompute COLUMN in a way
2634 that takes account of character widths. */
2635 if (BUFFERP (Vstandard_output))
2637 tem = Fcurrent_column ();
2638 column = XINT (tem);
2641 first = 0;
2645 if (BUFFERP (Vstandard_output))
2646 set_buffer_internal (old);
2648 if (!NILP (Vrun_hooks))
2650 int count1 = SPECPDL_INDEX ();
2652 specbind (intern ("completion-common-substring"), common_substring);
2653 call1 (Vrun_hooks, intern ("completion-setup-hook"));
2655 unbind_to (count1, Qnil);
2658 UNGCPRO;
2660 return Qnil;
2664 static Lisp_Object
2665 display_completion_list_1 (list)
2666 Lisp_Object list;
2668 return Fdisplay_completion_list (list, Qnil);
2671 DEFUN ("minibuffer-completion-help", Fminibuffer_completion_help, Sminibuffer_completion_help,
2672 0, 0, "",
2673 doc: /* Display a list of possible completions of the current minibuffer contents. */)
2676 Lisp_Object completions;
2678 message ("Making completion list...");
2679 completions = Fall_completions (Fminibuffer_completion_contents (),
2680 Vminibuffer_completion_table,
2681 Vminibuffer_completion_predicate,
2682 Qt);
2683 clear_message (1, 0);
2685 if (NILP (completions))
2687 bitch_at_user ();
2688 temp_echo_area_glyphs (build_string (" [No completions]"));
2690 else
2692 /* Sort and remove duplicates. */
2693 Lisp_Object tmp = completions = Fsort (completions, Qstring_lessp);
2694 while (CONSP (tmp))
2696 if (CONSP (XCDR (tmp))
2697 && !NILP (Fequal (XCAR (tmp), XCAR (XCDR (tmp)))))
2698 XSETCDR (tmp, XCDR (XCDR (tmp)));
2699 else
2700 tmp = XCDR (tmp);
2702 internal_with_output_to_temp_buffer ("*Completions*",
2703 display_completion_list_1,
2704 completions);
2706 return Qnil;
2709 DEFUN ("self-insert-and-exit", Fself_insert_and_exit, Sself_insert_and_exit, 0, 0, "",
2710 doc: /* Terminate minibuffer input. */)
2713 if (INTEGERP (last_command_char))
2714 internal_self_insert (XINT (last_command_char), 0);
2715 else
2716 bitch_at_user ();
2718 return Fexit_minibuffer ();
2721 DEFUN ("exit-minibuffer", Fexit_minibuffer, Sexit_minibuffer, 0, 0, "",
2722 doc: /* Terminate this minibuffer argument. */)
2725 /* If the command that uses this has made modifications in the minibuffer,
2726 we don't want them to cause deactivation of the mark in the original
2727 buffer.
2728 A better solution would be to make deactivate-mark buffer-local
2729 (or to turn it into a list of buffers, ...), but in the mean time,
2730 this should do the trick in most cases. */
2731 Vdeactivate_mark = Qnil;
2732 Fthrow (Qexit, Qnil);
2735 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2736 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2739 return make_number (minibuf_level);
2742 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2743 doc: /* Return the prompt string of the currently-active minibuffer.
2744 If no minibuffer is active, return nil. */)
2747 return Fcopy_sequence (minibuf_prompt);
2751 /* Temporarily display STRING at the end of the current
2752 minibuffer contents. This is used to display things like
2753 "[No Match]" when the user requests a completion for a prefix
2754 that has no possible completions, and other quick, unobtrusive
2755 messages. */
2757 extern Lisp_Object Vminibuffer_message_timeout;
2759 void
2760 temp_echo_area_glyphs (string)
2761 Lisp_Object string;
2763 int osize = ZV;
2764 int osize_byte = ZV_BYTE;
2765 int opoint = PT;
2766 int opoint_byte = PT_BYTE;
2767 Lisp_Object oinhibit;
2768 oinhibit = Vinhibit_quit;
2770 /* Clear out any old echo-area message to make way for our new thing. */
2771 message (0);
2773 SET_PT_BOTH (osize, osize_byte);
2774 insert_from_string (string, 0, 0, SCHARS (string), SBYTES (string), 0);
2775 SET_PT_BOTH (opoint, opoint_byte);
2776 Vinhibit_quit = Qt;
2778 if (NUMBERP (Vminibuffer_message_timeout))
2779 sit_for (Vminibuffer_message_timeout, 0, 2);
2780 else
2781 sit_for (Qt, 0, 2);
2783 del_range_both (osize, osize_byte, ZV, ZV_BYTE, 1);
2784 SET_PT_BOTH (opoint, opoint_byte);
2785 if (!NILP (Vquit_flag))
2787 Vquit_flag = Qnil;
2788 Vunread_command_events = Fcons (make_number (quit_char), Qnil);
2790 Vinhibit_quit = oinhibit;
2793 DEFUN ("minibuffer-message", Fminibuffer_message, Sminibuffer_message,
2794 1, 1, 0,
2795 doc: /* Temporarily display STRING at the end of the minibuffer.
2796 The text is displayed for a period controlled by `minibuffer-message-timeout',
2797 or until the next input event arrives, whichever comes first. */)
2798 (string)
2799 Lisp_Object string;
2801 CHECK_STRING (string);
2802 temp_echo_area_glyphs (string);
2803 return Qnil;
2806 void
2807 init_minibuf_once ()
2809 Vminibuffer_list = Qnil;
2810 staticpro (&Vminibuffer_list);
2813 void
2814 syms_of_minibuf ()
2816 minibuf_level = 0;
2817 minibuf_prompt = Qnil;
2818 staticpro (&minibuf_prompt);
2820 minibuf_save_list = Qnil;
2821 staticpro (&minibuf_save_list);
2823 Qread_file_name_internal = intern ("read-file-name-internal");
2824 staticpro (&Qread_file_name_internal);
2826 Qminibuffer_default = intern ("minibuffer-default");
2827 staticpro (&Qminibuffer_default);
2828 Fset (Qminibuffer_default, Qnil);
2830 Qminibuffer_completion_table = intern ("minibuffer-completion-table");
2831 staticpro (&Qminibuffer_completion_table);
2833 Qminibuffer_completion_confirm = intern ("minibuffer-completion-confirm");
2834 staticpro (&Qminibuffer_completion_confirm);
2836 Qminibuffer_completion_predicate = intern ("minibuffer-completion-predicate");
2837 staticpro (&Qminibuffer_completion_predicate);
2839 staticpro (&last_exact_completion);
2840 last_exact_completion = Qnil;
2842 staticpro (&last_minibuf_string);
2843 last_minibuf_string = Qnil;
2845 Quser_variable_p = intern ("user-variable-p");
2846 staticpro (&Quser_variable_p);
2848 Qminibuffer_history = intern ("minibuffer-history");
2849 staticpro (&Qminibuffer_history);
2851 Qbuffer_name_history = intern ("buffer-name-history");
2852 staticpro (&Qbuffer_name_history);
2853 Fset (Qbuffer_name_history, Qnil);
2855 Qminibuffer_setup_hook = intern ("minibuffer-setup-hook");
2856 staticpro (&Qminibuffer_setup_hook);
2858 Qminibuffer_exit_hook = intern ("minibuffer-exit-hook");
2859 staticpro (&Qminibuffer_exit_hook);
2861 Qhistory_length = intern ("history-length");
2862 staticpro (&Qhistory_length);
2864 Qcurrent_input_method = intern ("current-input-method");
2865 staticpro (&Qcurrent_input_method);
2867 Qactivate_input_method = intern ("activate-input-method");
2868 staticpro (&Qactivate_input_method);
2870 Qcase_fold_search = intern ("case-fold-search");
2871 staticpro (&Qcase_fold_search);
2873 Qread_expression_history = intern ("read-expression-history");
2874 staticpro (&Qread_expression_history);
2876 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2877 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2878 Vread_buffer_function = Qnil;
2880 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2881 doc: /* Normal hook run just after entry to minibuffer. */);
2882 Vminibuffer_setup_hook = Qnil;
2884 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2885 doc: /* Normal hook run just after exit from minibuffer. */);
2886 Vminibuffer_exit_hook = Qnil;
2888 DEFVAR_LISP ("history-length", &Vhistory_length,
2889 doc: /* *Maximum length for history lists before truncation takes place.
2890 A number means that length; t means infinite. Truncation takes place
2891 just after a new element is inserted. Setting the `history-length'
2892 property of a history variable overrides this default. */);
2893 XSETFASTINT (Vhistory_length, 30);
2895 DEFVAR_BOOL ("history-delete-duplicates", &history_delete_duplicates,
2896 doc: /* *Non-nil means to delete duplicates in history.
2897 If set to t when adding a new history element, all previous identical
2898 elements are deleted from the history list. */);
2899 history_delete_duplicates = 0;
2901 DEFVAR_LISP ("history-add-new-input", &Vhistory_add_new_input,
2902 doc: /* *Non-nil means to add new elements in history.
2903 If set to nil, minibuffer reading functions don't add new elements to the
2904 history list, so it is possible to do this afterwards by calling
2905 `add-to-history' explicitly. */);
2906 Vhistory_add_new_input = Qt;
2908 DEFVAR_LISP ("completion-auto-help", &Vcompletion_auto_help,
2909 doc: /* *Non-nil means automatically provide help for invalid completion input.
2910 Under Partial Completion mode, a non-nil, non-t value has a special meaning;
2911 see the doc string of `partial-completion-mode' for more details. */);
2912 Vcompletion_auto_help = Qt;
2914 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2915 doc: /* Non-nil means don't consider case significant in completion.
2917 For file-name completion, the variable `read-file-name-completion-ignore-case'
2918 controls the behavior, rather than this variable. */);
2919 completion_ignore_case = 0;
2921 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2922 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2923 This variable makes a difference whenever the minibuffer window is active. */);
2924 enable_recursive_minibuffers = 0;
2926 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2927 doc: /* Alist or obarray used for completion in the minibuffer.
2928 This becomes the ALIST argument to `try-completion' and `all-completions'.
2929 The value can also be a list of strings or a hash table.
2931 The value may alternatively be a function, which is given three arguments:
2932 STRING, the current buffer contents;
2933 PREDICATE, the predicate for filtering possible matches;
2934 CODE, which says what kind of things to do.
2935 CODE can be nil, t or `lambda':
2936 nil -- return the best completion of STRING, or nil if there is none.
2937 t -- return a list of all possible completions of STRING.
2938 lambda -- return t if STRING is a valid completion as it stands. */);
2939 Vminibuffer_completion_table = Qnil;
2941 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2942 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2943 Vminibuffer_completion_predicate = Qnil;
2945 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2946 doc: /* Non-nil means to demand confirmation of completion before exiting minibuffer. */);
2947 Vminibuffer_completion_confirm = Qnil;
2949 DEFVAR_LISP ("minibuffer-completing-file-name",
2950 &Vminibuffer_completing_file_name,
2951 doc: /* Non-nil and non-`lambda' means completing file names. */);
2952 Vminibuffer_completing_file_name = Qnil;
2954 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2955 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2956 Vminibuffer_help_form = Qnil;
2958 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2959 doc: /* History list symbol to add minibuffer values to.
2960 Each string of minibuffer input, as it appears on exit from the minibuffer,
2961 is added with
2962 (set minibuffer-history-variable
2963 (cons STRING (symbol-value minibuffer-history-variable))) */);
2964 XSETFASTINT (Vminibuffer_history_variable, 0);
2966 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2967 doc: /* Current position of redoing in the history list. */);
2968 Vminibuffer_history_position = Qnil;
2970 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2971 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2972 Some uses of the echo area also raise that frame (since they use it too). */);
2973 minibuffer_auto_raise = 0;
2975 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2976 doc: /* List of regexps that should restrict possible completions.
2977 The basic completion functions only consider a completion acceptable
2978 if it matches all regular expressions in this list, with
2979 `case-fold-search' bound to the value of `completion-ignore-case'.
2980 See Info node `(elisp)Basic Completion', for a description of these
2981 functions. */);
2982 Vcompletion_regexp_list = Qnil;
2984 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2985 &minibuffer_allow_text_properties,
2986 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2987 This also affects `read-string', but it does not affect `read-minibuffer',
2988 `read-no-blanks-input', or any of the functions that do minibuffer input
2989 with completion; they always discard text properties. */);
2990 minibuffer_allow_text_properties = 0;
2992 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2993 doc: /* Text properties that are added to minibuffer prompts.
2994 These are in addition to the basic `field' property, and stickiness
2995 properties. */);
2996 /* We use `intern' here instead of Qread_only to avoid
2997 initialization-order problems. */
2998 Vminibuffer_prompt_properties
2999 = Fcons (intern ("read-only"), Fcons (Qt, Qnil));
3001 DEFVAR_LISP ("read-expression-map", &Vread_expression_map,
3002 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
3003 Vread_expression_map = Qnil;
3005 defsubr (&Sset_minibuffer_window);
3006 defsubr (&Sread_from_minibuffer);
3007 defsubr (&Seval_minibuffer);
3008 defsubr (&Sread_minibuffer);
3009 defsubr (&Sread_string);
3010 defsubr (&Sread_command);
3011 defsubr (&Sread_variable);
3012 defsubr (&Sinternal_complete_buffer);
3013 defsubr (&Sread_buffer);
3014 defsubr (&Sread_no_blanks_input);
3015 defsubr (&Sminibuffer_depth);
3016 defsubr (&Sminibuffer_prompt);
3018 defsubr (&Sminibufferp);
3019 defsubr (&Sminibuffer_prompt_end);
3020 defsubr (&Sminibuffer_contents);
3021 defsubr (&Sminibuffer_contents_no_properties);
3022 defsubr (&Sminibuffer_completion_contents);
3023 defsubr (&Sdelete_minibuffer_contents);
3025 defsubr (&Stry_completion);
3026 defsubr (&Sall_completions);
3027 defsubr (&Stest_completion);
3028 defsubr (&Sassoc_string);
3029 defsubr (&Scompleting_read);
3030 defsubr (&Sminibuffer_complete);
3031 defsubr (&Sminibuffer_complete_word);
3032 defsubr (&Sminibuffer_complete_and_exit);
3033 defsubr (&Sdisplay_completion_list);
3034 defsubr (&Sminibuffer_completion_help);
3036 defsubr (&Sself_insert_and_exit);
3037 defsubr (&Sexit_minibuffer);
3039 defsubr (&Sminibuffer_message);
3042 void
3043 keys_of_minibuf ()
3045 initial_define_key (Vminibuffer_local_map, Ctl ('g'),
3046 "abort-recursive-edit");
3047 initial_define_key (Vminibuffer_local_map, Ctl ('m'),
3048 "exit-minibuffer");
3049 initial_define_key (Vminibuffer_local_map, Ctl ('j'),
3050 "exit-minibuffer");
3052 initial_define_key (Vminibuffer_local_ns_map, ' ',
3053 "exit-minibuffer");
3054 initial_define_key (Vminibuffer_local_ns_map, '\t',
3055 "exit-minibuffer");
3056 initial_define_key (Vminibuffer_local_ns_map, '?',
3057 "self-insert-and-exit");
3059 initial_define_key (Vminibuffer_local_completion_map, '\t',
3060 "minibuffer-complete");
3061 initial_define_key (Vminibuffer_local_completion_map, ' ',
3062 "minibuffer-complete-word");
3063 initial_define_key (Vminibuffer_local_completion_map, '?',
3064 "minibuffer-completion-help");
3066 Fdefine_key (Vminibuffer_local_filename_completion_map,
3067 build_string (" "), Qnil);
3069 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('m'),
3070 "minibuffer-complete-and-exit");
3071 initial_define_key (Vminibuffer_local_must_match_map, Ctl ('j'),
3072 "minibuffer-complete-and-exit");
3074 Fdefine_key (Vminibuffer_local_must_match_filename_map,
3075 build_string (" "), Qnil);
3078 /* arch-tag: 8f69b601-fba3-484c-a6dd-ceaee54a7a73
3079 (do not change this comment) */