Propagate buffer-local-variables changes to other threads.
[emacs.git] / src / minibuf.c
blobc6f62f52e2692da392c55c0922220e1d2e5e0e39
1 /* Minibuffer input and completion.
2 Copyright (C) 1985, 1986, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4 2008, 2009, 2010 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 3 of the License, or
11 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <stdio.h>
24 #include <setjmp.h>
26 #include "lisp.h"
27 #include "commands.h"
28 #include "buffer.h"
29 #include "character.h"
30 #include "dispextern.h"
31 #include "keyboard.h"
32 #include "frame.h"
33 #include "window.h"
34 #include "syntax.h"
35 #include "intervals.h"
36 #include "keymap.h"
37 #include "termhooks.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 /* The maximum length of a minibuffer history. */
59 Lisp_Object Qhistory_length, impl_Vhistory_length;
61 /* No duplicates in history. */
63 int history_delete_duplicates;
65 /* Non-nil means add new input to history. */
67 Lisp_Object impl_Vhistory_add_new_input;
69 /* Fread_minibuffer leaves the input here as a string. */
71 Lisp_Object last_minibuf_string;
73 /* Nonzero means let functions called when within a minibuffer
74 invoke recursive minibuffers (to read arguments, or whatever) */
76 int enable_recursive_minibuffers;
78 /* Nonzero means don't ignore text properties
79 in Fread_from_minibuffer. */
81 int minibuffer_allow_text_properties;
83 /* help-form is bound to this while in the minibuffer. */
85 Lisp_Object impl_Vminibuffer_help_form;
87 /* Variable which is the history list to add minibuffer values to. */
89 Lisp_Object impl_Vminibuffer_history_variable;
91 /* Current position in the history list (adjusted by M-n and M-p). */
93 Lisp_Object impl_Vminibuffer_history_position;
95 /* Text properties that are added to minibuffer prompts.
96 These are in addition to the basic `field' property, and stickiness
97 properties. */
99 Lisp_Object impl_Vminibuffer_prompt_properties;
101 Lisp_Object Qminibuffer_history, Qbuffer_name_history;
103 Lisp_Object Qread_file_name_internal;
105 /* Normal hooks for entry to and exit from minibuffer. */
107 Lisp_Object Qminibuffer_setup_hook, impl_Vminibuffer_setup_hook;
108 Lisp_Object Qminibuffer_exit_hook, impl_Vminibuffer_exit_hook;
110 /* Function to call to read a buffer name. */
111 Lisp_Object impl_Vread_buffer_function;
113 /* Nonzero means completion ignores case. */
115 int completion_ignore_case;
116 Lisp_Object Qcompletion_ignore_case;
117 int read_buffer_completion_ignore_case;
119 /* List of regexps that should restrict possible completions. */
121 Lisp_Object impl_Vcompletion_regexp_list;
123 /* Nonzero means raise the minibuffer frame when the minibuffer
124 is entered. */
126 int minibuffer_auto_raise;
128 /* Keymap for reading expressions. */
129 Lisp_Object impl_Vread_expression_map;
131 Lisp_Object impl_Vminibuffer_completion_table, Qminibuffer_completion_table;
132 Lisp_Object impl_Vminibuffer_completion_predicate, Qminibuffer_completion_predicate;
133 Lisp_Object impl_Vminibuffer_completion_confirm, Qminibuffer_completion_confirm;
134 Lisp_Object impl_Vminibuffer_completing_file_name;
136 Lisp_Object Quser_variable_p;
138 Lisp_Object Qminibuffer_default;
140 Lisp_Object Qcurrent_input_method, Qactivate_input_method;
142 Lisp_Object Qcase_fold_search;
144 Lisp_Object Qread_expression_history;
146 extern Lisp_Object impl_Voverriding_local_map;
148 extern Lisp_Object Qmouse_face;
150 extern Lisp_Object Qfield;
152 /* Put minibuf on currently selected frame's minibuffer.
153 We do this whenever the user starts a new minibuffer
154 or when a minibuffer exits. */
156 void
157 choose_minibuf_frame ()
159 if (FRAMEP (selected_frame)
160 && FRAME_LIVE_P (XFRAME (selected_frame))
161 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
163 struct frame *sf = XFRAME (selected_frame);
164 Lisp_Object buffer;
166 /* I don't think that any frames may validly have a null minibuffer
167 window anymore. */
168 if (NILP (sf->minibuffer_window))
169 abort ();
171 /* Under X, we come here with minibuf_window being the
172 minibuffer window of the unused termcap window created in
173 init_window_once. That window doesn't have a buffer. */
174 buffer = XWINDOW (minibuf_window)->buffer;
175 if (BUFFERP (buffer))
176 Fset_window_buffer (sf->minibuffer_window, buffer, Qnil);
177 minibuf_window = sf->minibuffer_window;
180 /* Make sure no other frame has a minibuffer as its selected window,
181 because the text would not be displayed in it, and that would be
182 confusing. Only allow the selected frame to do this,
183 and that only if the minibuffer is active. */
185 Lisp_Object tail, frame;
187 FOR_EACH_FRAME (tail, frame)
188 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
189 && !(EQ (frame, selected_frame)
190 && minibuf_level > 0))
191 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
195 Lisp_Object
196 choose_minibuf_frame_1 (ignore)
197 Lisp_Object ignore;
199 choose_minibuf_frame ();
200 return Qnil;
203 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
204 Sset_minibuffer_window, 1, 1, 0,
205 doc: /* Specify which minibuffer window to use for the minibuffer.
206 This affects where the minibuffer is displayed if you put text in it
207 without invoking the usual minibuffer commands. */)
208 (window)
209 Lisp_Object window;
211 CHECK_WINDOW (window);
212 if (! MINI_WINDOW_P (XWINDOW (window)))
213 error ("Window is not a minibuffer window");
215 minibuf_window = window;
217 return window;
221 /* Actual minibuffer invocation. */
223 static Lisp_Object read_minibuf_unwind P_ ((Lisp_Object));
224 static Lisp_Object run_exit_minibuf_hook P_ ((Lisp_Object));
225 static Lisp_Object read_minibuf P_ ((Lisp_Object, Lisp_Object,
226 Lisp_Object, Lisp_Object,
227 int, Lisp_Object,
228 Lisp_Object, Lisp_Object,
229 int, int));
230 static Lisp_Object read_minibuf_noninteractive P_ ((Lisp_Object, Lisp_Object,
231 Lisp_Object, Lisp_Object,
232 int, Lisp_Object,
233 Lisp_Object, Lisp_Object,
234 int, int));
235 static Lisp_Object string_to_object P_ ((Lisp_Object, Lisp_Object));
238 /* Read a Lisp object from VAL and return it. If VAL is an empty
239 string, and DEFALT is a string, read from DEFALT instead of VAL. */
241 static Lisp_Object
242 string_to_object (val, defalt)
243 Lisp_Object val, defalt;
245 struct gcpro gcpro1, gcpro2;
246 Lisp_Object expr_and_pos;
247 int pos;
249 GCPRO2 (val, defalt);
251 if (STRINGP (val) && SCHARS (val) == 0)
253 if (STRINGP (defalt))
254 val = defalt;
255 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
256 val = XCAR (defalt);
259 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
260 pos = XINT (Fcdr (expr_and_pos));
261 if (pos != SCHARS (val))
263 /* Ignore trailing whitespace; any other trailing junk
264 is an error. */
265 int i;
266 pos = string_char_to_byte (val, pos);
267 for (i = pos; i < SBYTES (val); i++)
269 int c = SREF (val, i);
270 if (c != ' ' && c != '\t' && c != '\n')
271 error ("Trailing garbage following expression");
275 val = Fcar (expr_and_pos);
276 RETURN_UNGCPRO (val);
280 /* Like read_minibuf but reading from stdin. This function is called
281 from read_minibuf to do the job if noninteractive. */
283 static Lisp_Object
284 read_minibuf_noninteractive (map, initial, prompt, backup_n, expflag,
285 histvar, histpos, defalt, allow_props,
286 inherit_input_method)
287 Lisp_Object map;
288 Lisp_Object initial;
289 Lisp_Object prompt;
290 Lisp_Object backup_n;
291 int expflag;
292 Lisp_Object histvar;
293 Lisp_Object histpos;
294 Lisp_Object defalt;
295 int allow_props;
296 int inherit_input_method;
298 int size, len;
299 char *line, *s;
300 Lisp_Object val;
302 fprintf (stdout, "%s", SDATA (prompt));
303 fflush (stdout);
305 val = Qnil;
306 size = 100;
307 len = 0;
308 line = (char *) xmalloc (size * sizeof *line);
309 while ((s = fgets (line + len, size - len, stdin)) != NULL
310 && (len = strlen (line),
311 len == size - 1 && line[len - 1] != '\n'))
313 size *= 2;
314 line = (char *) xrealloc (line, size);
317 if (s)
319 len = strlen (line);
321 if (len > 0 && line[len - 1] == '\n')
322 line[--len] = '\0';
324 val = build_string (line);
325 xfree (line);
327 else
329 xfree (line);
330 error ("Error reading from stdin");
333 /* If Lisp form desired instead of string, parse it. */
334 if (expflag)
335 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
337 return val;
340 DEFUN ("minibufferp", Fminibufferp,
341 Sminibufferp, 0, 1, 0,
342 doc: /* Return t if BUFFER is a minibuffer.
343 No argument or nil as argument means use current buffer as BUFFER.
344 BUFFER can be a buffer or a buffer name. */)
345 (buffer)
346 Lisp_Object buffer;
348 Lisp_Object tem;
350 if (NILP (buffer))
351 buffer = Fcurrent_buffer ();
352 else if (STRINGP (buffer))
353 buffer = Fget_buffer (buffer);
354 else
355 CHECK_BUFFER (buffer);
357 tem = Fmemq (buffer, Vminibuffer_list);
358 return ! NILP (tem) ? Qt : Qnil;
361 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
362 Sminibuffer_prompt_end, 0, 0, 0,
363 doc: /* Return the buffer position of the end of the minibuffer prompt.
364 Return (point-min) if current buffer is not a minibuffer. */)
367 /* This function is written to be most efficient when there's a prompt. */
368 Lisp_Object beg, end, tem;
369 beg = make_number (BEGV);
371 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
372 if (NILP (tem))
373 return beg;
375 end = Ffield_end (beg, Qnil, Qnil);
377 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
378 return beg;
379 else
380 return end;
383 DEFUN ("minibuffer-contents", Fminibuffer_contents,
384 Sminibuffer_contents, 0, 0, 0,
385 doc: /* Return the user input in a minibuffer as a string.
386 If the current buffer is not a minibuffer, return its entire contents. */)
389 int prompt_end = XINT (Fminibuffer_prompt_end ());
390 return make_buffer_string (prompt_end, ZV, 1);
393 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
394 Sminibuffer_contents_no_properties, 0, 0, 0,
395 doc: /* Return the user input in a minibuffer as a string, without text-properties.
396 If the current buffer is not a minibuffer, return its entire contents. */)
399 int prompt_end = XINT (Fminibuffer_prompt_end ());
400 return make_buffer_string (prompt_end, ZV, 0);
403 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
404 Sminibuffer_completion_contents, 0, 0, 0,
405 doc: /* Return the user input in a minibuffer before point as a string.
406 That is what completion commands operate on.
407 If the current buffer is not a minibuffer, return its entire contents. */)
410 int prompt_end = XINT (Fminibuffer_prompt_end ());
411 if (PT < prompt_end)
412 error ("Cannot do completion in the prompt");
413 return make_buffer_string (prompt_end, PT, 1);
417 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
418 putting point minus BACKUP_N bytes from the end of INITIAL,
419 prompting with PROMPT (a string), using history list HISTVAR
420 with initial position HISTPOS. INITIAL should be a string or a
421 cons of a string and an integer. BACKUP_N should be <= 0, or
422 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
423 ignored and replaced with an integer that puts point at one-indexed
424 position N in INITIAL, where N is the CDR of INITIAL, or at the
425 beginning of INITIAL if N <= 0.
427 Normally return the result as a string (the text that was read),
428 but if EXPFLAG is nonzero, read it and return the object read.
429 If HISTVAR is given, save the value read on that history only if it doesn't
430 match the front of that history list exactly. The value is pushed onto
431 the list as the string that was read.
433 DEFALT specifies the default value for the sake of history commands.
435 If ALLOW_PROPS is nonzero, we do not throw away text properties.
437 if INHERIT_INPUT_METHOD is nonzero, the minibuffer inherits the
438 current input method. */
440 static Lisp_Object
441 read_minibuf (map, initial, prompt, backup_n, expflag,
442 histvar, histpos, defalt, allow_props, inherit_input_method)
443 Lisp_Object map;
444 Lisp_Object initial;
445 Lisp_Object prompt;
446 Lisp_Object backup_n;
447 int expflag;
448 Lisp_Object histvar;
449 Lisp_Object histpos;
450 Lisp_Object defalt;
451 int allow_props;
452 int inherit_input_method;
454 Lisp_Object val;
455 int count = SPECPDL_INDEX ();
456 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
457 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
458 Lisp_Object enable_multibyte;
459 int pos = INTEGERP (backup_n) ? XINT (backup_n) : 0;
460 /* String to add to the history. */
461 Lisp_Object histstring;
463 Lisp_Object empty_minibuf;
464 Lisp_Object dummy, frame;
466 extern Lisp_Object Qfront_sticky;
467 extern Lisp_Object Qrear_nonsticky;
469 specbind (Qminibuffer_default, defalt);
471 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
472 in previous recursive minibuffer, but was not set explicitly
473 to t for this invocation, so set it to nil in this minibuffer.
474 Save the old value now, before we change it. */
475 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
476 if (EQ (Vminibuffer_completing_file_name, Qlambda))
477 Vminibuffer_completing_file_name = Qnil;
479 #ifdef HAVE_WINDOW_SYSTEM
480 if (display_hourglass_p)
481 cancel_hourglass ();
482 #endif
484 if (!NILP (initial))
486 if (CONSP (initial))
488 backup_n = Fcdr (initial);
489 initial = Fcar (initial);
490 CHECK_STRING (initial);
491 if (!NILP (backup_n))
493 CHECK_NUMBER (backup_n);
494 /* Convert to distance from end of input. */
495 if (XINT (backup_n) < 1)
496 /* A number too small means the beginning of the string. */
497 pos = - SCHARS (initial);
498 else
499 pos = XINT (backup_n) - 1 - SCHARS (initial);
502 else
503 CHECK_STRING (initial);
505 val = Qnil;
506 ambient_dir = BUF_DIRECTORY (current_buffer);
507 input_method = Qnil;
508 enable_multibyte = Qnil;
510 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
511 store them away before we can GC. Don't need to protect
512 BACKUP_N because we use the value only if it is an integer. */
513 GCPRO5 (map, initial, val, ambient_dir, input_method);
515 if (!STRINGP (prompt))
516 prompt = empty_unibyte_string;
518 if (!enable_recursive_minibuffers
519 && minibuf_level > 0)
521 if (EQ (selected_window, minibuf_window))
522 error ("Command attempted to use minibuffer while in minibuffer");
523 else
524 /* If we're in another window, cancel the minibuffer that's active. */
525 Fthrow (Qexit,
526 build_string ("Command attempted to use minibuffer while in minibuffer"));
529 if ((noninteractive
530 /* In case we are running as a daemon, only do this before
531 detaching from the terminal. */
532 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
533 && NILP (Vexecuting_kbd_macro))
535 val = read_minibuf_noninteractive (map, initial, prompt,
536 make_number (pos),
537 expflag, histvar, histpos, defalt,
538 allow_props, inherit_input_method);
539 UNGCPRO;
540 return unbind_to (count, val);
543 /* Choose the minibuffer window and frame, and take action on them. */
545 choose_minibuf_frame ();
547 record_unwind_protect (choose_minibuf_frame_1, Qnil);
549 record_unwind_protect (Fset_window_configuration,
550 Fcurrent_window_configuration (Qnil));
552 /* If the minibuffer window is on a different frame, save that
553 frame's configuration too. */
554 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
555 if (!EQ (mini_frame, selected_frame))
556 record_unwind_protect (Fset_window_configuration,
557 Fcurrent_window_configuration (mini_frame));
559 /* If the minibuffer is on an iconified or invisible frame,
560 make it visible now. */
561 Fmake_frame_visible (mini_frame);
563 if (minibuffer_auto_raise)
564 Fraise_frame (mini_frame);
566 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
568 /* We have to do this after saving the window configuration
569 since that is what restores the current buffer. */
571 /* Arrange to restore a number of minibuffer-related variables.
572 We could bind each variable separately, but that would use lots of
573 specpdl slots. */
574 minibuf_save_list
575 = Fcons (Voverriding_local_map,
576 Fcons (minibuf_window,
577 minibuf_save_list));
578 minibuf_save_list
579 = Fcons (minibuf_prompt,
580 Fcons (make_number (minibuf_prompt_width),
581 Fcons (Vhelp_form,
582 Fcons (Vcurrent_prefix_arg,
583 Fcons (Vminibuffer_history_position,
584 Fcons (Vminibuffer_history_variable,
585 minibuf_save_list))))));
588 Finhibit_yield (Qt);
589 record_unwind_protect (Finhibit_yield, Qnil);
590 record_unwind_protect (read_minibuf_unwind, Qnil);
591 minibuf_level++;
593 /* We are exiting the minibuffer one way or the other, so run the hook.
594 It should be run before unwinding the minibuf settings. Do it
595 separately from read_minibuf_unwind because we need to make sure that
596 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
597 signals an error. --Stef */
598 record_unwind_protect (run_exit_minibuf_hook, Qnil);
600 /* Now that we can restore all those variables, start changing them. */
602 minibuf_prompt_width = 0;
603 minibuf_prompt = Fcopy_sequence (prompt);
604 Vminibuffer_history_position = histpos;
605 Vminibuffer_history_variable = histvar;
606 Vhelp_form = Vminibuffer_help_form;
607 /* If this minibuffer is reading a file name, that doesn't mean
608 recursive ones are. But we cannot set it to nil, because
609 completion code still need to know the minibuffer is completing a
610 file name. So use `lambda' as intermediate value meaning
611 "t" in this minibuffer, but "nil" in next minibuffer. */
612 if (!NILP (Vminibuffer_completing_file_name))
613 Vminibuffer_completing_file_name = Qlambda;
615 if (inherit_input_method)
617 /* `current-input-method' is buffer local. So, remember it in
618 INPUT_METHOD before changing the current buffer. */
619 input_method = Fsymbol_value (Qcurrent_input_method);
620 enable_multibyte = BUF_ENABLE_MULTIBYTE_CHARACTERS (current_buffer);
623 /* Switch to the minibuffer. */
625 minibuffer = get_minibuffer (minibuf_level);
626 Fset_buffer (minibuffer);
628 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
629 if (inherit_input_method)
630 BUF_ENABLE_MULTIBYTE_CHARACTERS (current_buffer) = enable_multibyte;
632 /* The current buffer's default directory is usually the right thing
633 for our minibuffer here. However, if you're typing a command at
634 a minibuffer-only frame when minibuf_level is zero, then buf IS
635 the current_buffer, so reset_buffer leaves buf's default
636 directory unchanged. This is a bummer when you've just started
637 up Emacs and buf's default directory is Qnil. Here's a hack; can
638 you think of something better to do? Find another buffer with a
639 better directory, and use that one instead. */
640 if (STRINGP (ambient_dir))
641 BUF_DIRECTORY (current_buffer) = ambient_dir;
642 else
644 Lisp_Object buf_list;
646 for (buf_list = Vbuffer_alist;
647 CONSP (buf_list);
648 buf_list = XCDR (buf_list))
650 Lisp_Object other_buf;
652 other_buf = XCDR (XCAR (buf_list));
653 if (STRINGP (BUF_DIRECTORY (XBUFFER (other_buf))))
655 BUF_DIRECTORY (current_buffer) = BUF_DIRECTORY (XBUFFER (other_buf));
656 break;
661 if (!EQ (mini_frame, selected_frame))
662 Fredirect_frame_focus (selected_frame, mini_frame);
664 Vminibuf_scroll_window = selected_window;
665 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
666 minibuf_selected_window = selected_window;
668 /* Empty out the minibuffers of all frames other than the one
669 where we are going to display one now.
670 Set them to point to ` *Minibuf-0*', which is always empty. */
671 empty_minibuf = Fget_buffer (build_string (" *Minibuf-0*"));
673 FOR_EACH_FRAME (dummy, frame)
675 Lisp_Object root_window = Fframe_root_window (frame);
676 Lisp_Object mini_window = XWINDOW (root_window)->next;
678 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
679 && !NILP (Fwindow_minibuffer_p (mini_window)))
680 Fset_window_buffer (mini_window, empty_minibuf, Qnil);
683 /* Display this minibuffer in the proper window. */
684 Fset_window_buffer (minibuf_window, Fcurrent_buffer (), Qnil);
685 Fselect_window (minibuf_window, Qnil);
686 XSETFASTINT (XWINDOW (minibuf_window)->hscroll, 0);
688 Fmake_local_variable (Qprint_escape_newlines);
689 print_escape_newlines = 1;
691 /* Erase the buffer. */
693 int count1 = SPECPDL_INDEX ();
694 specbind (Qinhibit_read_only, Qt);
695 specbind (Qinhibit_modification_hooks, Qt);
696 Ferase_buffer ();
698 if (!NILP (BUF_ENABLE_MULTIBYTE_CHARACTERS (current_buffer))
699 && ! STRING_MULTIBYTE (minibuf_prompt))
700 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
702 /* Insert the prompt, record where it ends. */
703 Finsert (1, &minibuf_prompt);
704 if (PT > BEG)
706 Fput_text_property (make_number (BEG), make_number (PT),
707 Qfront_sticky, Qt, Qnil);
708 Fput_text_property (make_number (BEG), make_number (PT),
709 Qrear_nonsticky, Qt, Qnil);
710 Fput_text_property (make_number (BEG), make_number (PT),
711 Qfield, Qt, Qnil);
712 Fadd_text_properties (make_number (BEG), make_number (PT),
713 Vminibuffer_prompt_properties, Qnil);
715 unbind_to (count1, Qnil);
718 minibuf_prompt_width = (int) current_column (); /* iftc */
720 /* Put in the initial input. */
721 if (!NILP (initial))
723 Finsert (1, &initial);
724 Fforward_char (make_number (pos));
727 clear_message (1, 1);
728 BUF_KEYMAP (current_buffer) = map;
730 /* Turn on an input method stored in INPUT_METHOD if any. */
731 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
732 call1 (Qactivate_input_method, input_method);
734 /* Run our hook, but not if it is empty.
735 (run-hooks would do nothing if it is empty,
736 but it's important to save time here in the usual case.) */
737 if (!NILP (Vminibuffer_setup_hook) && !EQ (Vminibuffer_setup_hook, Qunbound)
738 && !NILP (Vrun_hooks))
739 call1 (Vrun_hooks, Qminibuffer_setup_hook);
741 /* Don't allow the user to undo past this point. */
742 BUF_UNDO_LIST (current_buffer) = Qnil;
744 recursive_edit_1 ();
746 /* If cursor is on the minibuffer line,
747 show the user we have exited by putting it in column 0. */
748 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
749 && !noninteractive)
751 XWINDOW (minibuf_window)->cursor.hpos = 0;
752 XWINDOW (minibuf_window)->cursor.x = 0;
753 XWINDOW (minibuf_window)->must_be_updated_p = 1;
754 update_frame (XFRAME (selected_frame), 1, 1);
756 struct frame *f = XFRAME (XWINDOW (minibuf_window)->frame);
757 struct redisplay_interface *rif = FRAME_RIF (f);
758 if (rif && rif->flush_display)
759 rif->flush_display (f);
763 /* Make minibuffer contents into a string. */
764 Fset_buffer (minibuffer);
765 if (allow_props)
766 val = Fminibuffer_contents ();
767 else
768 val = Fminibuffer_contents_no_properties ();
770 /* VAL is the string of minibuffer text. */
772 last_minibuf_string = val;
774 /* Choose the string to add to the history. */
775 if (SCHARS (val) != 0)
776 histstring = val;
777 else if (STRINGP (defalt))
778 histstring = defalt;
779 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
780 histstring = XCAR (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. */
795 histval = find_symbol_value (Vminibuffer_history_variable);
796 if (EQ (histval, Qunbound))
797 Fset (Vminibuffer_history_variable, Qnil);
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 (BUF_NAME (XBUFFER (buf))))
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 or the list of default values.
986 If non-nil, it is available for history commands, and as the value
987 (or the first element of the list of default values) to return
988 if the user enters the empty string. But, unless READ is non-nil,
989 `read-from-minibuffer' does NOT return DEFAULT-VALUE if the user enters
990 empty input! It returns the empty string.
991 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
992 the current input method and the setting of `enable-multibyte-characters'.
993 If the variable `minibuffer-allow-text-properties' is non-nil,
994 then the string which is returned includes whatever text properties
995 were present in the minibuffer. Otherwise the value has no text properties.
997 The remainder of this documentation string describes the
998 INITIAL-CONTENTS argument in more detail. It is only relevant when
999 studying existing code, or when HIST is a cons. If non-nil,
1000 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
1001 reading input. Normally, point is put at the end of that string.
1002 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
1003 input is STRING, but point is placed at _one-indexed_ position
1004 POSITION in the minibuffer. Any integer value less than or equal to
1005 one puts point at the beginning of the string. *Note* that this
1006 behavior differs from the way such arguments are used in `completing-read'
1007 and some related functions, which use zero-indexing for POSITION. */)
1008 (prompt, initial_contents, keymap, read, hist, default_value, inherit_input_method)
1009 Lisp_Object prompt, initial_contents, keymap, read, hist, default_value;
1010 Lisp_Object inherit_input_method;
1012 Lisp_Object histvar, histpos, val;
1013 struct gcpro gcpro1;
1015 CHECK_STRING (prompt);
1016 if (NILP (keymap))
1017 keymap = Vminibuffer_local_map;
1018 else
1019 keymap = get_keymap (keymap, 1, 0);
1021 if (SYMBOLP (hist))
1023 histvar = hist;
1024 histpos = Qnil;
1026 else
1028 histvar = Fcar_safe (hist);
1029 histpos = Fcdr_safe (hist);
1031 if (NILP (histvar))
1032 histvar = Qminibuffer_history;
1033 if (NILP (histpos))
1034 XSETFASTINT (histpos, 0);
1036 GCPRO1 (default_value);
1037 val = read_minibuf (keymap, initial_contents, prompt,
1038 Qnil, !NILP (read),
1039 histvar, histpos, default_value,
1040 minibuffer_allow_text_properties,
1041 !NILP (inherit_input_method));
1042 UNGCPRO;
1043 return val;
1046 DEFUN ("read-minibuffer", Fread_minibuffer, Sread_minibuffer, 1, 2, 0,
1047 doc: /* Return a Lisp object read using the minibuffer, unevaluated.
1048 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1049 is a string to insert in the minibuffer before reading.
1050 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1051 Such arguments are used as in `read-from-minibuffer'.) */)
1052 (prompt, initial_contents)
1053 Lisp_Object prompt, initial_contents;
1055 CHECK_STRING (prompt);
1056 return read_minibuf (Vminibuffer_local_map, initial_contents,
1057 prompt, Qnil, 1, Qminibuffer_history,
1058 make_number (0), Qnil, 0, 0);
1061 DEFUN ("eval-minibuffer", Feval_minibuffer, Seval_minibuffer, 1, 2, 0,
1062 doc: /* Return value of Lisp expression read using the minibuffer.
1063 Prompt with PROMPT. If non-nil, optional second arg INITIAL-CONTENTS
1064 is a string to insert in the minibuffer before reading.
1065 \(INITIAL-CONTENTS can also be a cons of a string and an integer.
1066 Such arguments are used as in `read-from-minibuffer'.) */)
1067 (prompt, initial_contents)
1068 Lisp_Object prompt, initial_contents;
1070 return Feval (read_minibuf (Vread_expression_map, initial_contents,
1071 prompt, Qnil, 1, Qread_expression_history,
1072 make_number (0), Qnil, 0, 0));
1075 /* Functions that use the minibuffer to read various things. */
1077 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
1078 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
1079 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
1080 This argument has been superseded by DEFAULT-VALUE and should normally
1081 be nil in new code. It behaves as in `read-from-minibuffer'. See the
1082 documentation string of that function for details.
1083 The third arg HISTORY, if non-nil, specifies a history list
1084 and optionally the initial position in the list.
1085 See `read-from-minibuffer' for details of HISTORY argument.
1086 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
1087 If non-nil, it is used for history commands, and as the value (or the first
1088 element of the list of default values) to return if the user enters the
1089 empty string.
1090 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1091 the current input method and the setting of `enable-multibyte-characters'. */)
1092 (prompt, initial_input, history, default_value, inherit_input_method)
1093 Lisp_Object prompt, initial_input, history, default_value;
1094 Lisp_Object inherit_input_method;
1096 Lisp_Object val;
1097 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
1098 Qnil, history, default_value,
1099 inherit_input_method);
1100 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
1101 val = CONSP (default_value) ? XCAR (default_value) : default_value;
1102 return val;
1105 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1106 doc: /* Read a string from the terminal, not allowing blanks.
1107 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1108 non-nil, it should be a string, which is used as initial input, with
1109 point positioned at the end, so that SPACE will accept the input.
1110 \(Actually, INITIAL can also be a cons of a string and an integer.
1111 Such values are treated as in `read-from-minibuffer', but are normally
1112 not useful in this function.)
1113 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1114 the current input method and the setting of`enable-multibyte-characters'. */)
1115 (prompt, initial, inherit_input_method)
1116 Lisp_Object prompt, initial, inherit_input_method;
1118 CHECK_STRING (prompt);
1119 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt, Qnil,
1120 0, Qminibuffer_history, make_number (0), Qnil, 0,
1121 !NILP (inherit_input_method));
1124 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1125 doc: /* Read the name of a command and return as a symbol.
1126 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1127 if it is a list. */)
1128 (prompt, default_value)
1129 Lisp_Object prompt, default_value;
1131 Lisp_Object name, default_string;
1133 if (NILP (default_value))
1134 default_string = Qnil;
1135 else if (SYMBOLP (default_value))
1136 default_string = SYMBOL_NAME (default_value);
1137 else
1138 default_string = default_value;
1140 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1141 Qnil, Qnil, default_string, Qnil);
1142 if (NILP (name))
1143 return name;
1144 return Fintern (name, Qnil);
1147 #ifdef NOTDEF
1148 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1149 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1150 Prompt with PROMPT. */)
1151 (prompt)
1152 Lisp_Object prompt;
1154 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1155 Qnil);
1157 #endif /* NOTDEF */
1159 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1160 doc: /* Read the name of a user variable and return it as a symbol.
1161 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1162 if it is a list.
1163 A user variable is one for which `user-variable-p' returns non-nil. */)
1164 (prompt, default_value)
1165 Lisp_Object prompt, default_value;
1167 Lisp_Object name, default_string;
1169 if (NILP (default_value))
1170 default_string = Qnil;
1171 else if (SYMBOLP (default_value))
1172 default_string = SYMBOL_NAME (default_value);
1173 else
1174 default_string = default_value;
1176 name = Fcompleting_read (prompt, Vobarray,
1177 Quser_variable_p, Qt,
1178 Qnil, Qnil, default_string, Qnil);
1179 if (NILP (name))
1180 return name;
1181 return Fintern (name, Qnil);
1184 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1185 doc: /* Read the name of a buffer and return as a string.
1186 Prompt with PROMPT.
1187 Optional second arg DEF is value to return if user enters an empty line.
1188 If DEF is a list of default values, return its first element.
1189 Optional third arg REQUIRE-MATCH determines whether non-existing
1190 buffer names are allowed. It has the same meaning as the
1191 REQUIRE-MATCH argument of `confirm-after-completion'.
1192 The argument PROMPT should be a string ending with a colon and a space.
1193 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1194 case while reading the buffer name.
1195 If `read-buffer-function' is non-nil, this works by calling it as a
1196 function, instead of the usual behavior. */)
1197 (prompt, def, require_match)
1198 Lisp_Object prompt, def, require_match;
1200 Lisp_Object args[4], result;
1201 unsigned char *s;
1202 int len;
1203 int count = SPECPDL_INDEX ();
1205 if (BUFFERP (def))
1206 def = BUF_NAME (XBUFFER (def));
1208 specbind (Qcompletion_ignore_case,
1209 read_buffer_completion_ignore_case ? Qt : Qnil);
1211 if (NILP (Vread_buffer_function))
1213 if (!NILP (def))
1215 /* A default value was provided: we must change PROMPT,
1216 editing the default value in before the colon. To achieve
1217 this, we replace PROMPT with a substring that doesn't
1218 contain the terminal space and colon (if present). They
1219 are then added back using Fformat. */
1221 if (STRINGP (prompt))
1223 s = SDATA (prompt);
1224 len = strlen (s);
1225 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1226 len = len - 2;
1227 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1228 len--;
1230 prompt = make_specified_string (s, -1, len,
1231 STRING_MULTIBYTE (prompt));
1234 args[0] = build_string ("%s (default %s): ");
1235 args[1] = prompt;
1236 args[2] = CONSP (def) ? XCAR (def) : def;
1237 prompt = Fformat (3, args);
1240 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1241 Qnil, require_match, Qnil, Qbuffer_name_history,
1242 def, Qnil);
1244 else
1246 args[0] = Vread_buffer_function;
1247 args[1] = prompt;
1248 args[2] = def;
1249 args[3] = require_match;
1250 result = Ffuncall(4, args);
1252 return unbind_to (count, result);
1255 static Lisp_Object
1256 minibuf_conform_representation (string, basis)
1257 Lisp_Object string, basis;
1259 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1260 return string;
1262 if (STRING_MULTIBYTE (string))
1263 return Fstring_make_unibyte (string);
1264 else
1265 return Fstring_make_multibyte (string);
1268 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1269 doc: /* Return common substring of all completions of STRING in COLLECTION.
1270 Test each possible completion specified by COLLECTION
1271 to see if it begins with STRING. The possible completions may be
1272 strings or symbols. Symbols are converted to strings before testing,
1273 see `symbol-name'.
1274 All that match STRING are compared together; the longest initial sequence
1275 common to all these matches is the return value.
1276 If there is no match at all, the return value is nil.
1277 For a unique match which is exact, the return value is t.
1279 If COLLECTION is an alist, the keys (cars of elements) are the
1280 possible completions. If an element is not a cons cell, then the
1281 element itself is the possible completion.
1282 If COLLECTION is a hash-table, all the keys that are strings or symbols
1283 are the possible completions.
1284 If COLLECTION is an obarray, the names of all symbols in the obarray
1285 are the possible completions.
1287 COLLECTION can also be a function to do the completion itself.
1288 It receives three arguments: the values STRING, PREDICATE and nil.
1289 Whatever it returns becomes the value of `try-completion'.
1291 If optional third argument PREDICATE is non-nil,
1292 it is used to test each possible match.
1293 The match is a candidate only if PREDICATE returns non-nil.
1294 The argument given to PREDICATE is the alist element
1295 or the symbol from the obarray. If COLLECTION is a hash-table,
1296 predicate is called with two arguments: the key and the value.
1297 Additionally to this predicate, `completion-regexp-list'
1298 is used to further constrain the set of candidates. */)
1299 (string, collection, predicate)
1300 Lisp_Object string, collection, predicate;
1302 Lisp_Object bestmatch, tail, elt, eltstring;
1303 /* Size in bytes of BESTMATCH. */
1304 int bestmatchsize = 0;
1305 /* These are in bytes, too. */
1306 int compare, matchsize;
1307 enum { function_table, list_table, obarray_table, hash_table}
1308 type = (HASH_TABLE_P (collection) ? hash_table
1309 : VECTORP (collection) ? obarray_table
1310 : ((NILP (collection)
1311 || (CONSP (collection)
1312 && (!SYMBOLP (XCAR (collection))
1313 || NILP (XCAR (collection)))))
1314 ? list_table : function_table));
1315 int index = 0, obsize = 0;
1316 int matchcount = 0;
1317 int bindcount = -1;
1318 Lisp_Object bucket, zero, end, tem;
1319 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1321 CHECK_STRING (string);
1322 if (type == function_table)
1323 return call3 (collection, string, predicate, Qnil);
1325 bestmatch = bucket = Qnil;
1326 zero = make_number (0);
1328 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1329 tail = collection;
1330 if (type == obarray_table)
1332 collection = check_obarray (collection);
1333 obsize = XVECTOR (collection)->size;
1334 bucket = XVECTOR (collection)->contents[index];
1337 while (1)
1339 /* Get the next element of the alist, obarray, or hash-table. */
1340 /* Exit the loop if the elements are all used up. */
1341 /* elt gets the alist element or symbol.
1342 eltstring gets the name to check as a completion. */
1344 if (type == list_table)
1346 if (!CONSP (tail))
1347 break;
1348 elt = XCAR (tail);
1349 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1350 tail = XCDR (tail);
1352 else if (type == obarray_table)
1354 if (!EQ (bucket, zero))
1356 if (!SYMBOLP (bucket))
1357 error ("Bad data in guts of obarray");
1358 elt = bucket;
1359 eltstring = elt;
1360 if (XSYMBOL (bucket)->next)
1361 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1362 else
1363 XSETFASTINT (bucket, 0);
1365 else if (++index >= obsize)
1366 break;
1367 else
1369 bucket = XVECTOR (collection)->contents[index];
1370 continue;
1373 else /* if (type == hash_table) */
1375 while (index < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1376 && NILP (HASH_HASH (XHASH_TABLE (collection), index)))
1377 index++;
1378 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1379 break;
1380 else
1381 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), index++);
1384 /* Is this element a possible completion? */
1386 if (SYMBOLP (eltstring))
1387 eltstring = Fsymbol_name (eltstring);
1389 if (STRINGP (eltstring)
1390 && SCHARS (string) <= SCHARS (eltstring)
1391 && (tem = Fcompare_strings (eltstring, zero,
1392 make_number (SCHARS (string)),
1393 string, zero, Qnil,
1394 completion_ignore_case ? Qt : Qnil),
1395 EQ (Qt, tem)))
1397 /* Yes. */
1398 Lisp_Object regexps;
1400 /* Ignore this element if it fails to match all the regexps. */
1402 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1403 regexps = XCDR (regexps))
1405 if (bindcount < 0) {
1406 bindcount = SPECPDL_INDEX ();
1407 specbind (Qcase_fold_search,
1408 completion_ignore_case ? Qt : Qnil);
1410 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1411 if (NILP (tem))
1412 break;
1414 if (CONSP (regexps))
1415 continue;
1418 /* Ignore this element if there is a predicate
1419 and the predicate doesn't like it. */
1421 if (!NILP (predicate))
1423 if (EQ (predicate, Qcommandp))
1424 tem = Fcommandp (elt, Qnil);
1425 else
1427 if (bindcount >= 0)
1429 unbind_to (bindcount, Qnil);
1430 bindcount = -1;
1432 GCPRO4 (tail, string, eltstring, bestmatch);
1433 tem = (type == hash_table
1434 ? call2 (predicate, elt,
1435 HASH_VALUE (XHASH_TABLE (collection),
1436 index - 1))
1437 : call1 (predicate, elt));
1438 UNGCPRO;
1440 if (NILP (tem)) continue;
1443 /* Update computation of how much all possible completions match */
1445 if (NILP (bestmatch))
1447 matchcount = 1;
1448 bestmatch = eltstring;
1449 bestmatchsize = SCHARS (eltstring);
1451 else
1453 compare = min (bestmatchsize, SCHARS (eltstring));
1454 tem = Fcompare_strings (bestmatch, zero,
1455 make_number (compare),
1456 eltstring, zero,
1457 make_number (compare),
1458 completion_ignore_case ? Qt : Qnil);
1459 if (EQ (tem, Qt))
1460 matchsize = compare;
1461 else if (XINT (tem) < 0)
1462 matchsize = - XINT (tem) - 1;
1463 else
1464 matchsize = XINT (tem) - 1;
1466 if (completion_ignore_case)
1468 /* If this is an exact match except for case,
1469 use it as the best match rather than one that is not an
1470 exact match. This way, we get the case pattern
1471 of the actual match. */
1472 if ((matchsize == SCHARS (eltstring)
1473 && matchsize < SCHARS (bestmatch))
1475 /* If there is more than one exact match ignoring case,
1476 and one of them is exact including case,
1477 prefer that one. */
1478 /* If there is no exact match ignoring case,
1479 prefer a match that does not change the case
1480 of the input. */
1481 ((matchsize == SCHARS (eltstring))
1483 (matchsize == SCHARS (bestmatch))
1484 && (tem = Fcompare_strings (eltstring, zero,
1485 make_number (SCHARS (string)),
1486 string, zero,
1487 Qnil,
1488 Qnil),
1489 EQ (Qt, tem))
1490 && (tem = Fcompare_strings (bestmatch, zero,
1491 make_number (SCHARS (string)),
1492 string, zero,
1493 Qnil,
1494 Qnil),
1495 ! EQ (Qt, tem))))
1496 bestmatch = eltstring;
1498 if (bestmatchsize != SCHARS (eltstring)
1499 || bestmatchsize != matchsize)
1500 /* Don't count the same string multiple times. */
1501 matchcount++;
1502 bestmatchsize = matchsize;
1503 if (matchsize <= SCHARS (string)
1504 /* If completion-ignore-case is non-nil, don't
1505 short-circuit because we want to find the best
1506 possible match *including* case differences. */
1507 && !completion_ignore_case
1508 && matchcount > 1)
1509 /* No need to look any further. */
1510 break;
1515 if (bindcount >= 0) {
1516 unbind_to (bindcount, Qnil);
1517 bindcount = -1;
1520 if (NILP (bestmatch))
1521 return Qnil; /* No completions found */
1522 /* If we are ignoring case, and there is no exact match,
1523 and no additional text was supplied,
1524 don't change the case of what the user typed. */
1525 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1526 && SCHARS (bestmatch) > bestmatchsize)
1527 return minibuf_conform_representation (string, bestmatch);
1529 /* Return t if the supplied string is an exact match (counting case);
1530 it does not require any change to be made. */
1531 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1532 return Qt;
1534 XSETFASTINT (zero, 0); /* Else extract the part in which */
1535 XSETFASTINT (end, bestmatchsize); /* all completions agree */
1536 return Fsubstring (bestmatch, zero, end);
1539 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1540 doc: /* Search for partial matches to STRING in COLLECTION.
1541 Test each of the possible completions specified by COLLECTION
1542 to see if it begins with STRING. The possible completions may be
1543 strings or symbols. Symbols are converted to strings before testing,
1544 see `symbol-name'.
1545 The value is a list of all the possible completions that match STRING.
1547 If COLLECTION is an alist, the keys (cars of elements) are the
1548 possible completions. If an element is not a cons cell, then the
1549 element itself is the possible completion.
1550 If COLLECTION is a hash-table, all the keys that are strings or symbols
1551 are the possible completions.
1552 If COLLECTION is an obarray, the names of all symbols in the obarray
1553 are the possible completions.
1555 COLLECTION can also be a function to do the completion itself.
1556 It receives three arguments: the values STRING, PREDICATE and t.
1557 Whatever it returns becomes the value of `all-completions'.
1559 If optional third argument PREDICATE is non-nil,
1560 it is used to test each possible match.
1561 The match is a candidate only if PREDICATE returns non-nil.
1562 The argument given to PREDICATE is the alist element
1563 or the symbol from the obarray. If COLLECTION is a hash-table,
1564 predicate is called with two arguments: the key and the value.
1565 Additionally to this predicate, `completion-regexp-list'
1566 is used to further constrain the set of candidates.
1568 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1569 backward compatibility. If non-nil, strings in COLLECTION that start
1570 with a space are ignored unless STRING itself starts with a space. */)
1571 (string, collection, predicate, hide_spaces)
1572 Lisp_Object string, collection, predicate, hide_spaces;
1574 Lisp_Object tail, elt, eltstring;
1575 Lisp_Object allmatches;
1576 int type = HASH_TABLE_P (collection) ? 3
1577 : VECTORP (collection) ? 2
1578 : NILP (collection) || (CONSP (collection)
1579 && (!SYMBOLP (XCAR (collection))
1580 || NILP (XCAR (collection))));
1581 int index = 0, obsize = 0;
1582 int bindcount = -1;
1583 Lisp_Object bucket, tem, zero;
1584 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1586 CHECK_STRING (string);
1587 if (type == 0)
1588 return call3 (collection, string, predicate, Qt);
1589 allmatches = bucket = Qnil;
1590 zero = make_number (0);
1592 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1593 tail = collection;
1594 if (type == 2)
1596 obsize = XVECTOR (collection)->size;
1597 bucket = XVECTOR (collection)->contents[index];
1600 while (1)
1602 /* Get the next element of the alist, obarray, or hash-table. */
1603 /* Exit the loop if the elements are all used up. */
1604 /* elt gets the alist element or symbol.
1605 eltstring gets the name to check as a completion. */
1607 if (type == 1)
1609 if (!CONSP (tail))
1610 break;
1611 elt = XCAR (tail);
1612 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1613 tail = XCDR (tail);
1615 else if (type == 2)
1617 if (!EQ (bucket, zero))
1619 elt = bucket;
1620 eltstring = elt;
1621 if (XSYMBOL (bucket)->next)
1622 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1623 else
1624 XSETFASTINT (bucket, 0);
1626 else if (++index >= obsize)
1627 break;
1628 else
1630 bucket = XVECTOR (collection)->contents[index];
1631 continue;
1634 else /* if (type == 3) */
1636 while (index < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1637 && NILP (HASH_HASH (XHASH_TABLE (collection), index)))
1638 index++;
1639 if (index >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1640 break;
1641 else
1642 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), index++);
1645 /* Is this element a possible completion? */
1647 if (SYMBOLP (eltstring))
1648 eltstring = Fsymbol_name (eltstring);
1650 if (STRINGP (eltstring)
1651 && SCHARS (string) <= SCHARS (eltstring)
1652 /* If HIDE_SPACES, reject alternatives that start with space
1653 unless the input starts with space. */
1654 && (NILP (hide_spaces)
1655 || (SBYTES (string) > 0
1656 && SREF (string, 0) == ' ')
1657 || SREF (eltstring, 0) != ' ')
1658 && (tem = Fcompare_strings (eltstring, zero,
1659 make_number (SCHARS (string)),
1660 string, zero,
1661 make_number (SCHARS (string)),
1662 completion_ignore_case ? Qt : Qnil),
1663 EQ (Qt, tem)))
1665 /* Yes. */
1666 Lisp_Object regexps;
1667 Lisp_Object zero;
1668 XSETFASTINT (zero, 0);
1670 /* Ignore this element if it fails to match all the regexps. */
1672 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1673 regexps = XCDR (regexps))
1675 if (bindcount < 0) {
1676 bindcount = SPECPDL_INDEX ();
1677 specbind (Qcase_fold_search,
1678 completion_ignore_case ? Qt : Qnil);
1680 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1681 if (NILP (tem))
1682 break;
1684 if (CONSP (regexps))
1685 continue;
1688 /* Ignore this element if there is a predicate
1689 and the predicate doesn't like it. */
1691 if (!NILP (predicate))
1693 if (EQ (predicate, Qcommandp))
1694 tem = Fcommandp (elt, Qnil);
1695 else
1697 if (bindcount >= 0) {
1698 unbind_to (bindcount, Qnil);
1699 bindcount = -1;
1701 GCPRO4 (tail, eltstring, allmatches, string);
1702 tem = type == 3
1703 ? call2 (predicate, elt,
1704 HASH_VALUE (XHASH_TABLE (collection), index - 1))
1705 : call1 (predicate, elt);
1706 UNGCPRO;
1708 if (NILP (tem)) continue;
1710 /* Ok => put it on the list. */
1711 allmatches = Fcons (eltstring, allmatches);
1715 if (bindcount >= 0) {
1716 unbind_to (bindcount, Qnil);
1717 bindcount = -1;
1720 return Fnreverse (allmatches);
1723 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1724 doc: /* Read a string in the minibuffer, with completion.
1725 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1726 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1727 COLLECTION can also be a function to do the completion itself.
1728 PREDICATE limits completion to a subset of COLLECTION.
1729 See `try-completion' and `all-completions' for more details
1730 on completion, COLLECTION, and PREDICATE.
1732 REQUIRE-MATCH can take the following values:
1733 - t means that the user is not allowed to exit unless
1734 the input is (or completes to) an element of COLLECTION or is null.
1735 - nil means that the user can exit with any input.
1736 - `confirm' means that the user can exit with any input, but she needs
1737 to confirm her choice if the input is not an element of COLLECTION.
1738 - `confirm-after-completion' means that the user can exit with any
1739 input, but she needs to confirm her choice if she called
1740 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1741 and the input is not an element of COLLECTION.
1742 - anything else behaves like t except that typing RET does not exit if it
1743 does non-null completion.
1745 If the input is null, `completing-read' returns DEF, or the first element
1746 of the list of default values, or an empty string if DEF is nil,
1747 regardless of the value of REQUIRE-MATCH.
1749 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1750 with point positioned at the end.
1751 If it is (STRING . POSITION), the initial input is STRING, but point
1752 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1753 that this is different from `read-from-minibuffer' and related
1754 functions, which use one-indexing for POSITION.) This feature is
1755 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1756 default value DEF instead. The user can yank the default value into
1757 the minibuffer easily using \\[next-history-element].
1759 HIST, if non-nil, specifies a history list and optionally the initial
1760 position in the list. It can be a symbol, which is the history list
1761 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1762 that case, HISTVAR is the history list variable to use, and HISTPOS
1763 is the initial position (the position in the list used by the
1764 minibuffer history commands). For consistency, you should also
1765 specify that element of the history as the value of
1766 INITIAL-INPUT. (This is the only case in which you should use
1767 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1768 1 at the beginning of the list. The variable `history-length'
1769 controls the maximum length of a history list.
1771 DEF, if non-nil, is the default value or the list of default values.
1773 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1774 the current input method and the setting of `enable-multibyte-characters'.
1776 Completion ignores case if the ambient value of
1777 `completion-ignore-case' is non-nil. */)
1778 (prompt, collection, predicate, require_match, initial_input, hist, def, inherit_input_method)
1779 Lisp_Object prompt, collection, predicate, require_match, initial_input;
1780 Lisp_Object hist, def, inherit_input_method;
1782 Lisp_Object val, histvar, histpos, position;
1783 Lisp_Object init;
1784 int pos = 0;
1785 int count = SPECPDL_INDEX ();
1786 struct gcpro gcpro1;
1788 init = initial_input;
1789 GCPRO1 (def);
1791 specbind (Qminibuffer_completion_table, collection);
1792 specbind (Qminibuffer_completion_predicate, predicate);
1793 specbind (Qminibuffer_completion_confirm,
1794 EQ (require_match, Qt) ? Qnil : require_match);
1796 position = Qnil;
1797 if (!NILP (init))
1799 if (CONSP (init))
1801 position = Fcdr (init);
1802 init = Fcar (init);
1804 CHECK_STRING (init);
1805 if (!NILP (position))
1807 CHECK_NUMBER (position);
1808 /* Convert to distance from end of input. */
1809 pos = XINT (position) - SCHARS (init);
1813 if (SYMBOLP (hist))
1815 histvar = hist;
1816 histpos = Qnil;
1818 else
1820 histvar = Fcar_safe (hist);
1821 histpos = Fcdr_safe (hist);
1823 if (NILP (histvar))
1824 histvar = Qminibuffer_history;
1825 if (NILP (histpos))
1826 XSETFASTINT (histpos, 0);
1828 val = read_minibuf (NILP (require_match)
1829 ? (NILP (Vminibuffer_completing_file_name)
1830 || EQ (Vminibuffer_completing_file_name, Qlambda)
1831 ? Vminibuffer_local_completion_map
1832 : Vminibuffer_local_filename_completion_map)
1833 : (NILP (Vminibuffer_completing_file_name)
1834 || EQ (Vminibuffer_completing_file_name, Qlambda)
1835 ? Vminibuffer_local_must_match_map
1836 : Vminibuffer_local_filename_must_match_map),
1837 init, prompt, make_number (pos), 0,
1838 histvar, histpos, def, 0,
1839 !NILP (inherit_input_method));
1841 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (def))
1842 val = CONSP (def) ? XCAR (def) : def;
1844 RETURN_UNGCPRO (unbind_to (count, val));
1847 Lisp_Object Fassoc_string ();
1849 /* Test whether TXT is an exact completion. */
1850 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1851 doc: /* Return non-nil if STRING is a valid completion.
1852 Takes the same arguments as `all-completions' and `try-completion'.
1853 If COLLECTION is a function, it is called with three arguments:
1854 the values STRING, PREDICATE and `lambda'. */)
1855 (string, collection, predicate)
1856 Lisp_Object string, collection, predicate;
1858 Lisp_Object regexps, tail, tem = Qnil;
1859 int i = 0;
1861 CHECK_STRING (string);
1863 if ((CONSP (collection)
1864 && (!SYMBOLP (XCAR (collection)) || NILP (XCAR (collection))))
1865 || NILP (collection))
1867 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1868 if (NILP (tem))
1869 return Qnil;
1871 else if (VECTORP (collection))
1873 /* Bypass intern-soft as that loses for nil. */
1874 tem = oblookup (collection,
1875 SDATA (string),
1876 SCHARS (string),
1877 SBYTES (string));
1878 if (!SYMBOLP (tem))
1880 if (STRING_MULTIBYTE (string))
1881 string = Fstring_make_unibyte (string);
1882 else
1883 string = Fstring_make_multibyte (string);
1885 tem = oblookup (collection,
1886 SDATA (string),
1887 SCHARS (string),
1888 SBYTES (string));
1891 if (completion_ignore_case && !SYMBOLP (tem))
1893 for (i = XVECTOR (collection)->size - 1; i >= 0; i--)
1895 tail = XVECTOR (collection)->contents[i];
1896 if (SYMBOLP (tail))
1897 while (1)
1899 if (EQ((Fcompare_strings (string, make_number (0), Qnil,
1900 Fsymbol_name (tail),
1901 make_number (0) , Qnil, Qt)),
1902 Qt))
1904 tem = tail;
1905 break;
1907 if (XSYMBOL (tail)->next == 0)
1908 break;
1909 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1914 if (!SYMBOLP (tem))
1915 return Qnil;
1917 else if (HASH_TABLE_P (collection))
1919 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1920 i = hash_lookup (h, string, NULL);
1921 if (i >= 0)
1922 tem = HASH_KEY (h, i);
1923 else
1924 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1925 if (!NILP (HASH_HASH (h, i)) &&
1926 EQ (Fcompare_strings (string, make_number (0), Qnil,
1927 HASH_KEY (h, i), make_number (0) , Qnil,
1928 completion_ignore_case ? Qt : Qnil),
1929 Qt))
1931 tem = HASH_KEY (h, i);
1932 break;
1934 if (!STRINGP (tem))
1935 return Qnil;
1937 else
1938 return call3 (collection, string, predicate, Qlambda);
1940 /* Reject this element if it fails to match all the regexps. */
1941 if (CONSP (Vcompletion_regexp_list))
1943 int count = SPECPDL_INDEX ();
1944 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1945 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1946 regexps = XCDR (regexps))
1948 if (NILP (Fstring_match (XCAR (regexps),
1949 SYMBOLP (tem) ? string : tem,
1950 Qnil)))
1951 return unbind_to (count, Qnil);
1953 unbind_to (count, Qnil);
1956 /* Finally, check the predicate. */
1957 if (!NILP (predicate))
1959 return HASH_TABLE_P (collection)
1960 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1961 : call1 (predicate, tem);
1963 else
1964 return Qt;
1967 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1968 doc: /* Perform completion on buffer names.
1969 If the argument FLAG is nil, invoke `try-completion', if it's t, invoke
1970 `all-completions', otherwise invoke `test-completion'.
1972 The arguments STRING and PREDICATE are as in `try-completion',
1973 `all-completions', and `test-completion'. */)
1974 (string, predicate, flag)
1975 Lisp_Object string, predicate, flag;
1977 if (NILP (flag))
1978 return Ftry_completion (string, Vbuffer_alist, predicate);
1979 else if (EQ (flag, Qt))
1981 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1982 if (SCHARS (string) > 0)
1983 return res;
1984 else
1985 { /* Strip out internal buffers. */
1986 Lisp_Object bufs = res;
1987 /* First, look for a non-internal buffer in `res'. */
1988 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1989 bufs = XCDR (bufs);
1990 if (NILP (bufs))
1991 /* All bufs in `res' are internal, so don't trip them out. */
1992 return res;
1993 res = bufs;
1994 while (CONSP (XCDR (bufs)))
1995 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1996 XSETCDR (bufs, XCDR (XCDR (bufs)));
1997 else
1998 bufs = XCDR (bufs);
1999 return res;
2002 else /* assume `lambda' */
2003 return Ftest_completion (string, Vbuffer_alist, predicate);
2006 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
2008 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
2009 doc: /* Like `assoc' but specifically for strings (and symbols).
2011 This returns the first element of LIST whose car matches the string or
2012 symbol KEY, or nil if no match exists. When performing the
2013 comparison, symbols are first converted to strings, and unibyte
2014 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
2015 is ignored.
2017 Unlike `assoc', KEY can also match an entry in LIST consisting of a
2018 single string, rather than a cons cell whose car is a string. */)
2019 (key, list, case_fold)
2020 register Lisp_Object key;
2021 Lisp_Object list, case_fold;
2023 register Lisp_Object tail;
2025 if (SYMBOLP (key))
2026 key = Fsymbol_name (key);
2028 for (tail = list; CONSP (tail); tail = XCDR (tail))
2030 register Lisp_Object elt, tem, thiscar;
2031 elt = XCAR (tail);
2032 thiscar = CONSP (elt) ? XCAR (elt) : elt;
2033 if (SYMBOLP (thiscar))
2034 thiscar = Fsymbol_name (thiscar);
2035 else if (!STRINGP (thiscar))
2036 continue;
2037 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
2038 key, make_number (0), Qnil,
2039 case_fold);
2040 if (EQ (tem, Qt))
2041 return elt;
2042 QUIT;
2044 return Qnil;
2048 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
2049 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
2052 return make_number (minibuf_level);
2055 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
2056 doc: /* Return the prompt string of the currently-active minibuffer.
2057 If no minibuffer is active, return nil. */)
2060 return Fcopy_sequence (minibuf_prompt);
2064 void
2065 init_minibuf_once ()
2067 Vminibuffer_list = Qnil;
2068 staticpro (&Vminibuffer_list);
2071 void
2072 syms_of_minibuf ()
2074 minibuf_level = 0;
2075 minibuf_prompt = Qnil;
2076 staticpro (&minibuf_prompt);
2078 minibuf_save_list = Qnil;
2079 staticpro (&minibuf_save_list);
2081 Qcompletion_ignore_case = intern_c_string ("completion-ignore-case");
2082 staticpro (&Qcompletion_ignore_case);
2084 Qread_file_name_internal = intern_c_string ("read-file-name-internal");
2085 staticpro (&Qread_file_name_internal);
2087 Qminibuffer_default = intern_c_string ("minibuffer-default");
2088 staticpro (&Qminibuffer_default);
2089 Fset (Qminibuffer_default, Qnil);
2091 Qminibuffer_completion_table = intern_c_string ("minibuffer-completion-table");
2092 staticpro (&Qminibuffer_completion_table);
2094 Qminibuffer_completion_confirm = intern_c_string ("minibuffer-completion-confirm");
2095 staticpro (&Qminibuffer_completion_confirm);
2097 Qminibuffer_completion_predicate = intern_c_string ("minibuffer-completion-predicate");
2098 staticpro (&Qminibuffer_completion_predicate);
2100 staticpro (&last_minibuf_string);
2101 last_minibuf_string = Qnil;
2103 Quser_variable_p = intern_c_string ("user-variable-p");
2104 staticpro (&Quser_variable_p);
2106 Qminibuffer_history = intern_c_string ("minibuffer-history");
2107 staticpro (&Qminibuffer_history);
2109 Qbuffer_name_history = intern_c_string ("buffer-name-history");
2110 staticpro (&Qbuffer_name_history);
2111 Fset (Qbuffer_name_history, Qnil);
2113 Qminibuffer_setup_hook = intern_c_string ("minibuffer-setup-hook");
2114 staticpro (&Qminibuffer_setup_hook);
2116 Qminibuffer_exit_hook = intern_c_string ("minibuffer-exit-hook");
2117 staticpro (&Qminibuffer_exit_hook);
2119 Qhistory_length = intern_c_string ("history-length");
2120 staticpro (&Qhistory_length);
2122 Qcurrent_input_method = intern_c_string ("current-input-method");
2123 staticpro (&Qcurrent_input_method);
2125 Qactivate_input_method = intern_c_string ("activate-input-method");
2126 staticpro (&Qactivate_input_method);
2128 Qcase_fold_search = intern_c_string ("case-fold-search");
2129 staticpro (&Qcase_fold_search);
2131 Qread_expression_history = intern_c_string ("read-expression-history");
2132 staticpro (&Qread_expression_history);
2134 DEFVAR_LISP ("read-buffer-function", &Vread_buffer_function,
2135 doc: /* If this is non-nil, `read-buffer' does its work by calling this function. */);
2136 Vread_buffer_function = Qnil;
2138 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
2139 &read_buffer_completion_ignore_case,
2140 doc: /* *Non-nil means completion ignores case when reading a buffer name. */);
2141 read_buffer_completion_ignore_case = 0;
2143 DEFVAR_LISP ("minibuffer-setup-hook", &Vminibuffer_setup_hook,
2144 doc: /* Normal hook run just after entry to minibuffer. */);
2145 Vminibuffer_setup_hook = Qnil;
2147 DEFVAR_LISP ("minibuffer-exit-hook", &Vminibuffer_exit_hook,
2148 doc: /* Normal hook run just after exit from minibuffer. */);
2149 Vminibuffer_exit_hook = Qnil;
2151 DEFVAR_LISP ("history-length", &Vhistory_length,
2152 doc: /* *Maximum length for history lists before truncation takes place.
2153 A number means that length; t means infinite. Truncation takes place
2154 just after a new element is inserted. Setting the `history-length'
2155 property of a history variable overrides this default. */);
2156 XSETFASTINT (Vhistory_length, 30);
2158 DEFVAR_BOOL ("history-delete-duplicates", &history_delete_duplicates,
2159 doc: /* *Non-nil means to delete duplicates in history.
2160 If set to t when adding a new history element, all previous identical
2161 elements are deleted from the history list. */);
2162 history_delete_duplicates = 0;
2164 DEFVAR_LISP ("history-add-new-input", &Vhistory_add_new_input,
2165 doc: /* *Non-nil means to add new elements in history.
2166 If set to nil, minibuffer reading functions don't add new elements to the
2167 history list, so it is possible to do this afterwards by calling
2168 `add-to-history' explicitly. */);
2169 Vhistory_add_new_input = Qt;
2171 DEFVAR_BOOL ("completion-ignore-case", &completion_ignore_case,
2172 doc: /* Non-nil means don't consider case significant in completion.
2173 For file-name completion, `read-file-name-completion-ignore-case'
2174 controls the behavior, rather than this variable.
2175 For buffer name completion, `read-buffer-completion-ignore-case'
2176 controls the behavior, rather than this variable. */);
2177 completion_ignore_case = 0;
2179 DEFVAR_BOOL ("enable-recursive-minibuffers", &enable_recursive_minibuffers,
2180 doc: /* *Non-nil means to allow minibuffer commands while in the minibuffer.
2181 This variable makes a difference whenever the minibuffer window is active. */);
2182 enable_recursive_minibuffers = 0;
2184 DEFVAR_LISP ("minibuffer-completion-table", &Vminibuffer_completion_table,
2185 doc: /* Alist or obarray used for completion in the minibuffer.
2186 This becomes the ALIST argument to `try-completion' and `all-completions'.
2187 The value can also be a list of strings or a hash table.
2189 The value may alternatively be a function, which is given three arguments:
2190 STRING, the current buffer contents;
2191 PREDICATE, the predicate for filtering possible matches;
2192 CODE, which says what kind of things to do.
2193 CODE can be nil, t or `lambda':
2194 nil -- return the best completion of STRING, or nil if there is none.
2195 t -- return a list of all possible completions of STRING.
2196 lambda -- return t if STRING is a valid completion as it stands. */);
2197 Vminibuffer_completion_table = Qnil;
2199 DEFVAR_LISP ("minibuffer-completion-predicate", &Vminibuffer_completion_predicate,
2200 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2201 Vminibuffer_completion_predicate = Qnil;
2203 DEFVAR_LISP ("minibuffer-completion-confirm", &Vminibuffer_completion_confirm,
2204 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2205 If nil, confirmation is not required.
2206 If the value is `confirm', the user may exit with an input that is not
2207 a valid completion alternative, but Emacs asks for confirmation.
2208 If the value is `confirm-after-completion', the user may exit with an
2209 input that is not a valid completion alternative, but Emacs asks for
2210 confirmation if the user submitted the input right after any of the
2211 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2212 Vminibuffer_completion_confirm = Qnil;
2214 DEFVAR_LISP ("minibuffer-completing-file-name",
2215 &Vminibuffer_completing_file_name,
2216 doc: /* Non-nil means completing file names. */);
2217 Vminibuffer_completing_file_name = Qnil;
2219 DEFVAR_LISP ("minibuffer-help-form", &Vminibuffer_help_form,
2220 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2221 Vminibuffer_help_form = Qnil;
2223 DEFVAR_LISP ("minibuffer-history-variable", &Vminibuffer_history_variable,
2224 doc: /* History list symbol to add minibuffer values to.
2225 Each string of minibuffer input, as it appears on exit from the minibuffer,
2226 is added with
2227 (set minibuffer-history-variable
2228 (cons STRING (symbol-value minibuffer-history-variable))) */);
2229 XSETFASTINT (Vminibuffer_history_variable, 0);
2231 DEFVAR_LISP ("minibuffer-history-position", &Vminibuffer_history_position,
2232 doc: /* Current position of redoing in the history list. */);
2233 Vminibuffer_history_position = Qnil;
2235 DEFVAR_BOOL ("minibuffer-auto-raise", &minibuffer_auto_raise,
2236 doc: /* *Non-nil means entering the minibuffer raises the minibuffer's frame.
2237 Some uses of the echo area also raise that frame (since they use it too). */);
2238 minibuffer_auto_raise = 0;
2240 DEFVAR_LISP ("completion-regexp-list", &Vcompletion_regexp_list,
2241 doc: /* List of regexps that should restrict possible completions.
2242 The basic completion functions only consider a completion acceptable
2243 if it matches all regular expressions in this list, with
2244 `case-fold-search' bound to the value of `completion-ignore-case'.
2245 See Info node `(elisp)Basic Completion', for a description of these
2246 functions. */);
2247 Vcompletion_regexp_list = Qnil;
2249 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2250 &minibuffer_allow_text_properties,
2251 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2252 This also affects `read-string', but it does not affect `read-minibuffer',
2253 `read-no-blanks-input', or any of the functions that do minibuffer input
2254 with completion; they always discard text properties. */);
2255 minibuffer_allow_text_properties = 0;
2257 DEFVAR_LISP ("minibuffer-prompt-properties", &Vminibuffer_prompt_properties,
2258 doc: /* Text properties that are added to minibuffer prompts.
2259 These are in addition to the basic `field' property, and stickiness
2260 properties. */);
2261 /* We use `intern' here instead of Qread_only to avoid
2262 initialization-order problems. */
2263 Vminibuffer_prompt_properties
2264 = Fcons (intern_c_string ("read-only"), Fcons (Qt, Qnil));
2266 DEFVAR_LISP ("read-expression-map", &Vread_expression_map,
2267 doc: /* Minibuffer keymap used for reading Lisp expressions. */);
2268 Vread_expression_map = Qnil;
2270 defsubr (&Sset_minibuffer_window);
2271 defsubr (&Sread_from_minibuffer);
2272 defsubr (&Seval_minibuffer);
2273 defsubr (&Sread_minibuffer);
2274 defsubr (&Sread_string);
2275 defsubr (&Sread_command);
2276 defsubr (&Sread_variable);
2277 defsubr (&Sinternal_complete_buffer);
2278 defsubr (&Sread_buffer);
2279 defsubr (&Sread_no_blanks_input);
2280 defsubr (&Sminibuffer_depth);
2281 defsubr (&Sminibuffer_prompt);
2283 defsubr (&Sminibufferp);
2284 defsubr (&Sminibuffer_prompt_end);
2285 defsubr (&Sminibuffer_contents);
2286 defsubr (&Sminibuffer_contents_no_properties);
2287 defsubr (&Sminibuffer_completion_contents);
2289 defsubr (&Stry_completion);
2290 defsubr (&Sall_completions);
2291 defsubr (&Stest_completion);
2292 defsubr (&Sassoc_string);
2293 defsubr (&Scompleting_read);
2296 /* arch-tag: 8f69b601-fba3-484c-a6dd-ceaee54a7a73
2297 (do not change this comment) */