Improve reftex-format-special
[bpt/emacs.git] / src / minibuf.c
1 /* Minibuffer input and completion.
2
3 Copyright (C) 1985-1986, 1993-2014 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24
25 #include "lisp.h"
26 #include "commands.h"
27 #include "character.h"
28 #include "buffer.h"
29 #include "dispextern.h"
30 #include "keyboard.h"
31 #include "frame.h"
32 #include "window.h"
33 #include "syntax.h"
34 #include "intervals.h"
35 #include "keymap.h"
36 #include "termhooks.h"
37
38 /* List of buffers for use as minibuffers.
39 The first element of the list is used for the outermost minibuffer
40 invocation, the next element is used for a recursive minibuffer
41 invocation, etc. The list is extended at the end as deeper
42 minibuffer recursions are encountered. */
43
44 Lisp_Object Vminibuffer_list;
45
46 /* Data to remember during recursive minibuffer invocations. */
47
48 static Lisp_Object minibuf_save_list;
49
50 /* Depth in minibuffer invocations. */
51
52 EMACS_INT minibuf_level;
53
54 /* The maximum length of a minibuffer history. */
55
56 static Lisp_Object Qhistory_length;
57
58 /* Fread_minibuffer leaves the input here as a string. */
59
60 Lisp_Object last_minibuf_string;
61
62 static Lisp_Object Qminibuffer_history, Qbuffer_name_history;
63
64 static Lisp_Object Qread_file_name_internal;
65
66 /* Normal hooks for entry to and exit from minibuffer. */
67
68 static Lisp_Object Qminibuffer_setup_hook;
69 static Lisp_Object Qminibuffer_exit_hook;
70
71 Lisp_Object Qcompletion_ignore_case;
72 static Lisp_Object Qminibuffer_completion_table;
73 static Lisp_Object Qminibuffer_completion_predicate;
74 static Lisp_Object Qminibuffer_completion_confirm;
75 static Lisp_Object Qcustom_variable_p;
76
77 static Lisp_Object Qminibuffer_default;
78
79 static Lisp_Object Qcurrent_input_method, Qactivate_input_method;
80
81 static Lisp_Object Qcase_fold_search;
82
83 static Lisp_Object Qread_expression_history;
84
85 /* Prompt to display in front of the mini-buffer contents. */
86
87 static Lisp_Object minibuf_prompt;
88
89 /* Width of current mini-buffer prompt. Only set after display_line
90 of the line that contains the prompt. */
91
92 static ptrdiff_t minibuf_prompt_width;
93
94 \f
95 /* Put minibuf on currently selected frame's minibuffer.
96 We do this whenever the user starts a new minibuffer
97 or when a minibuffer exits. */
98
99 static void
100 choose_minibuf_frame (void)
101 {
102 if (FRAMEP (selected_frame)
103 && FRAME_LIVE_P (XFRAME (selected_frame))
104 && !EQ (minibuf_window, XFRAME (selected_frame)->minibuffer_window))
105 {
106 struct frame *sf = XFRAME (selected_frame);
107 Lisp_Object buffer;
108
109 /* I don't think that any frames may validly have a null minibuffer
110 window anymore. */
111 if (NILP (sf->minibuffer_window))
112 emacs_abort ();
113
114 /* Under X, we come here with minibuf_window being the
115 minibuffer window of the unused termcap window created in
116 init_window_once. That window doesn't have a buffer. */
117 buffer = XWINDOW (minibuf_window)->contents;
118 if (BUFFERP (buffer))
119 /* Use set_window_buffer instead of Fset_window_buffer (see
120 discussion of bug#11984, bug#12025, bug#12026). */
121 set_window_buffer (sf->minibuffer_window, buffer, 0, 0);
122 minibuf_window = sf->minibuffer_window;
123 }
124
125 /* Make sure no other frame has a minibuffer as its selected window,
126 because the text would not be displayed in it, and that would be
127 confusing. Only allow the selected frame to do this,
128 and that only if the minibuffer is active. */
129 {
130 Lisp_Object tail, frame;
131
132 FOR_EACH_FRAME (tail, frame)
133 if (MINI_WINDOW_P (XWINDOW (FRAME_SELECTED_WINDOW (XFRAME (frame))))
134 && !(EQ (frame, selected_frame)
135 && minibuf_level > 0))
136 Fset_frame_selected_window (frame, Fframe_first_window (frame), Qnil);
137 }
138 }
139
140 DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
141 Sactive_minibuffer_window, 0, 0, 0,
142 doc: /* Return the currently active minibuffer window, or nil if none. */)
143 (void)
144 {
145 return minibuf_level ? minibuf_window : Qnil;
146 }
147
148 DEFUN ("set-minibuffer-window", Fset_minibuffer_window,
149 Sset_minibuffer_window, 1, 1, 0,
150 doc: /* Specify which minibuffer window to use for the minibuffer.
151 This affects where the minibuffer is displayed if you put text in it
152 without invoking the usual minibuffer commands. */)
153 (Lisp_Object window)
154 {
155 CHECK_WINDOW (window);
156 if (! MINI_WINDOW_P (XWINDOW (window)))
157 error ("Window is not a minibuffer window");
158
159 minibuf_window = window;
160
161 return window;
162 }
163
164 \f
165 /* Actual minibuffer invocation. */
166
167 static void read_minibuf_unwind (void);
168 static void run_exit_minibuf_hook (void);
169
170
171 /* Read a Lisp object from VAL and return it. If VAL is an empty
172 string, and DEFALT is a string, read from DEFALT instead of VAL. */
173
174 static Lisp_Object
175 string_to_object (Lisp_Object val, Lisp_Object defalt)
176 {
177 struct gcpro gcpro1, gcpro2;
178 Lisp_Object expr_and_pos;
179 ptrdiff_t pos;
180
181 GCPRO2 (val, defalt);
182
183 if (STRINGP (val) && SCHARS (val) == 0)
184 {
185 if (STRINGP (defalt))
186 val = defalt;
187 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
188 val = XCAR (defalt);
189 }
190
191 expr_and_pos = Fread_from_string (val, Qnil, Qnil);
192 pos = XINT (Fcdr (expr_and_pos));
193 if (pos != SCHARS (val))
194 {
195 /* Ignore trailing whitespace; any other trailing junk
196 is an error. */
197 ptrdiff_t i;
198 pos = string_char_to_byte (val, pos);
199 for (i = pos; i < SBYTES (val); i++)
200 {
201 int c = SREF (val, i);
202 if (c != ' ' && c != '\t' && c != '\n')
203 error ("Trailing garbage following expression");
204 }
205 }
206
207 val = Fcar (expr_and_pos);
208 RETURN_UNGCPRO (val);
209 }
210
211
212 /* Like read_minibuf but reading from stdin. This function is called
213 from read_minibuf to do the job if noninteractive. */
214
215 static Lisp_Object
216 read_minibuf_noninteractive (Lisp_Object map, Lisp_Object initial,
217 Lisp_Object prompt, Lisp_Object backup_n,
218 bool expflag,
219 Lisp_Object histvar, Lisp_Object histpos,
220 Lisp_Object defalt,
221 bool allow_props, bool inherit_input_method)
222 {
223 ptrdiff_t size, len;
224 char *line;
225 Lisp_Object val;
226 int c;
227
228 fprintf (stdout, "%s", SDATA (prompt));
229 fflush (stdout);
230
231 val = Qnil;
232 size = 100;
233 len = 0;
234 line = xmalloc (size);
235
236 while ((c = getchar ()) != '\n')
237 {
238 if (c == EOF)
239 {
240 if (errno != EINTR)
241 break;
242 }
243 else
244 {
245 if (len == size)
246 {
247 if (STRING_BYTES_BOUND / 2 < size)
248 memory_full (SIZE_MAX);
249 size *= 2;
250 line = xrealloc (line, size);
251 }
252 line[len++] = c;
253 }
254 }
255
256 if (len || c == '\n')
257 {
258 val = make_string (line, len);
259 xfree (line);
260 }
261 else
262 {
263 xfree (line);
264 error ("Error reading from stdin");
265 }
266
267 /* If Lisp form desired instead of string, parse it. */
268 if (expflag)
269 val = string_to_object (val, CONSP (defalt) ? XCAR (defalt) : defalt);
270
271 return val;
272 }
273 \f
274 DEFUN ("minibufferp", Fminibufferp,
275 Sminibufferp, 0, 1, 0,
276 doc: /* Return t if BUFFER is a minibuffer.
277 No argument or nil as argument means use current buffer as BUFFER.
278 BUFFER can be a buffer or a buffer name. */)
279 (Lisp_Object buffer)
280 {
281 Lisp_Object tem;
282
283 if (NILP (buffer))
284 buffer = Fcurrent_buffer ();
285 else if (STRINGP (buffer))
286 buffer = Fget_buffer (buffer);
287 else
288 CHECK_BUFFER (buffer);
289
290 tem = Fmemq (buffer, Vminibuffer_list);
291 return ! NILP (tem) ? Qt : Qnil;
292 }
293
294 DEFUN ("minibuffer-prompt-end", Fminibuffer_prompt_end,
295 Sminibuffer_prompt_end, 0, 0, 0,
296 doc: /* Return the buffer position of the end of the minibuffer prompt.
297 Return (point-min) if current buffer is not a minibuffer. */)
298 (void)
299 {
300 /* This function is written to be most efficient when there's a prompt. */
301 Lisp_Object beg, end, tem;
302 beg = make_number (BEGV);
303
304 tem = Fmemq (Fcurrent_buffer (), Vminibuffer_list);
305 if (NILP (tem))
306 return beg;
307
308 end = Ffield_end (beg, Qnil, Qnil);
309
310 if (XINT (end) == ZV && NILP (Fget_char_property (beg, Qfield, Qnil)))
311 return beg;
312 else
313 return end;
314 }
315
316 DEFUN ("minibuffer-contents", Fminibuffer_contents,
317 Sminibuffer_contents, 0, 0, 0,
318 doc: /* Return the user input in a minibuffer as a string.
319 If the current buffer is not a minibuffer, return its entire contents. */)
320 (void)
321 {
322 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
323 return make_buffer_string (prompt_end, ZV, 1);
324 }
325
326 DEFUN ("minibuffer-contents-no-properties", Fminibuffer_contents_no_properties,
327 Sminibuffer_contents_no_properties, 0, 0, 0,
328 doc: /* Return the user input in a minibuffer as a string, without text-properties.
329 If the current buffer is not a minibuffer, return its entire contents. */)
330 (void)
331 {
332 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
333 return make_buffer_string (prompt_end, ZV, 0);
334 }
335
336 DEFUN ("minibuffer-completion-contents", Fminibuffer_completion_contents,
337 Sminibuffer_completion_contents, 0, 0, 0,
338 doc: /* Return the user input in a minibuffer before point as a string.
339 That is what completion commands operate on.
340 If the current buffer is not a minibuffer, return its entire contents. */)
341 (void)
342 {
343 ptrdiff_t prompt_end = XINT (Fminibuffer_prompt_end ());
344 if (PT < prompt_end)
345 error ("Cannot do completion in the prompt");
346 return make_buffer_string (prompt_end, PT, 1);
347 }
348
349 \f
350 /* Read from the minibuffer using keymap MAP and initial contents INITIAL,
351 putting point minus BACKUP_N bytes from the end of INITIAL,
352 prompting with PROMPT (a string), using history list HISTVAR
353 with initial position HISTPOS. INITIAL should be a string or a
354 cons of a string and an integer. BACKUP_N should be <= 0, or
355 Qnil, which is equivalent to 0. If INITIAL is a cons, BACKUP_N is
356 ignored and replaced with an integer that puts point at one-indexed
357 position N in INITIAL, where N is the CDR of INITIAL, or at the
358 beginning of INITIAL if N <= 0.
359
360 Normally return the result as a string (the text that was read),
361 but if EXPFLAG, read it and return the object read.
362 If HISTVAR is given, save the value read on that history only if it doesn't
363 match the front of that history list exactly. The value is pushed onto
364 the list as the string that was read.
365
366 DEFALT specifies the default value for the sake of history commands.
367
368 If ALLOW_PROPS, do not throw away text properties.
369
370 if INHERIT_INPUT_METHOD, the minibuffer inherits the
371 current input method. */
372
373 static Lisp_Object
374 read_minibuf (Lisp_Object map, Lisp_Object initial, Lisp_Object prompt,
375 bool expflag,
376 Lisp_Object histvar, Lisp_Object histpos, Lisp_Object defalt,
377 bool allow_props, bool inherit_input_method)
378 {
379 Lisp_Object val;
380 ptrdiff_t count = SPECPDL_INDEX ();
381 Lisp_Object mini_frame, ambient_dir, minibuffer, input_method;
382 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
383 Lisp_Object enable_multibyte;
384 EMACS_INT pos = 0;
385 /* String to add to the history. */
386 Lisp_Object histstring;
387 Lisp_Object histval;
388
389 Lisp_Object empty_minibuf;
390 Lisp_Object dummy, frame;
391
392 specbind (Qminibuffer_default, defalt);
393 specbind (intern ("inhibit-read-only"), Qnil);
394
395 /* If Vminibuffer_completing_file_name is `lambda' on entry, it was t
396 in previous recursive minibuffer, but was not set explicitly
397 to t for this invocation, so set it to nil in this minibuffer.
398 Save the old value now, before we change it. */
399 specbind (intern ("minibuffer-completing-file-name"), Vminibuffer_completing_file_name);
400 if (EQ (Vminibuffer_completing_file_name, Qlambda))
401 Vminibuffer_completing_file_name = Qnil;
402
403 #ifdef HAVE_WINDOW_SYSTEM
404 if (display_hourglass_p)
405 cancel_hourglass ();
406 #endif
407
408 if (!NILP (initial))
409 {
410 if (CONSP (initial))
411 {
412 Lisp_Object backup_n = XCDR (initial);
413 initial = XCAR (initial);
414 CHECK_STRING (initial);
415 if (!NILP (backup_n))
416 {
417 CHECK_NUMBER (backup_n);
418 /* Convert to distance from end of input. */
419 if (XINT (backup_n) < 1)
420 /* A number too small means the beginning of the string. */
421 pos = - SCHARS (initial);
422 else
423 pos = XINT (backup_n) - 1 - SCHARS (initial);
424 }
425 }
426 else
427 CHECK_STRING (initial);
428 }
429 val = Qnil;
430 ambient_dir = BVAR (current_buffer, directory);
431 input_method = Qnil;
432 enable_multibyte = Qnil;
433
434 /* Don't need to protect PROMPT, HISTVAR, and HISTPOS because we
435 store them away before we can GC. Don't need to protect
436 BACKUP_N because we use the value only if it is an integer. */
437 GCPRO5 (map, initial, val, ambient_dir, input_method);
438
439 if (!STRINGP (prompt))
440 prompt = empty_unibyte_string;
441
442 if (!enable_recursive_minibuffers
443 && minibuf_level > 0)
444 {
445 if (EQ (selected_window, minibuf_window))
446 error ("Command attempted to use minibuffer while in minibuffer");
447 else
448 /* If we're in another window, cancel the minibuffer that's active. */
449 Fthrow (Qexit,
450 build_string ("Command attempted to use minibuffer while in minibuffer"));
451 }
452
453 if ((noninteractive
454 /* In case we are running as a daemon, only do this before
455 detaching from the terminal. */
456 || (IS_DAEMON && (daemon_pipe[1] >= 0)))
457 && NILP (Vexecuting_kbd_macro))
458 {
459 val = read_minibuf_noninteractive (map, initial, prompt,
460 make_number (pos),
461 expflag, histvar, histpos, defalt,
462 allow_props, inherit_input_method);
463 UNGCPRO;
464 return unbind_to (count, val);
465 }
466
467 /* Choose the minibuffer window and frame, and take action on them. */
468
469 /* Prepare for restoring the current buffer since choose_minibuf_frame
470 calling Fset_frame_selected_window may change it (Bug#12766). */
471 record_unwind_protect (restore_buffer, Fcurrent_buffer ());
472
473 choose_minibuf_frame ();
474
475 record_unwind_protect_void (choose_minibuf_frame);
476
477 record_unwind_protect (restore_window_configuration,
478 Fcurrent_window_configuration (Qnil));
479
480 /* If the minibuffer window is on a different frame, save that
481 frame's configuration too. */
482 mini_frame = WINDOW_FRAME (XWINDOW (minibuf_window));
483 if (!EQ (mini_frame, selected_frame))
484 record_unwind_protect (restore_window_configuration,
485 Fcurrent_window_configuration (mini_frame));
486
487 /* If the minibuffer is on an iconified or invisible frame,
488 make it visible now. */
489 Fmake_frame_visible (mini_frame);
490
491 if (minibuffer_auto_raise)
492 Fraise_frame (mini_frame);
493
494 temporarily_switch_to_single_kboard (XFRAME (mini_frame));
495
496 /* We have to do this after saving the window configuration
497 since that is what restores the current buffer. */
498
499 /* Arrange to restore a number of minibuffer-related variables.
500 We could bind each variable separately, but that would use lots of
501 specpdl slots. */
502 minibuf_save_list
503 = Fcons (Voverriding_local_map,
504 Fcons (minibuf_window,
505 minibuf_save_list));
506 minibuf_save_list
507 = Fcons (minibuf_prompt,
508 Fcons (make_number (minibuf_prompt_width),
509 Fcons (Vhelp_form,
510 Fcons (Vcurrent_prefix_arg,
511 Fcons (Vminibuffer_history_position,
512 Fcons (Vminibuffer_history_variable,
513 minibuf_save_list))))));
514
515 record_unwind_protect_void (read_minibuf_unwind);
516 minibuf_level++;
517 /* We are exiting the minibuffer one way or the other, so run the hook.
518 It should be run before unwinding the minibuf settings. Do it
519 separately from read_minibuf_unwind because we need to make sure that
520 read_minibuf_unwind is fully executed even if exit-minibuffer-hook
521 signals an error. --Stef */
522 record_unwind_protect_void (run_exit_minibuf_hook);
523
524 /* Now that we can restore all those variables, start changing them. */
525
526 minibuf_prompt_width = 0;
527 minibuf_prompt = Fcopy_sequence (prompt);
528 Vminibuffer_history_position = histpos;
529 Vminibuffer_history_variable = histvar;
530 Vhelp_form = Vminibuffer_help_form;
531 /* If this minibuffer is reading a file name, that doesn't mean
532 recursive ones are. But we cannot set it to nil, because
533 completion code still need to know the minibuffer is completing a
534 file name. So use `lambda' as intermediate value meaning
535 "t" in this minibuffer, but "nil" in next minibuffer. */
536 if (!NILP (Vminibuffer_completing_file_name))
537 Vminibuffer_completing_file_name = Qlambda;
538
539 /* If variable is unbound, make it nil. */
540 histval = find_symbol_value (Vminibuffer_history_variable);
541 if (EQ (histval, Qunbound))
542 {
543 Fset (Vminibuffer_history_variable, Qnil);
544 histval = Qnil;
545 }
546
547 if (inherit_input_method)
548 {
549 /* `current-input-method' is buffer local. So, remember it in
550 INPUT_METHOD before changing the current buffer. */
551 input_method = Fsymbol_value (Qcurrent_input_method);
552 enable_multibyte = BVAR (current_buffer, enable_multibyte_characters);
553 }
554
555 /* Switch to the minibuffer. */
556
557 minibuffer = get_minibuffer (minibuf_level);
558 Fset_buffer (minibuffer);
559
560 /* Defeat (setq-default truncate-lines t), since truncated lines do
561 not work correctly in minibuffers. (Bug#5715, etc) */
562 bset_truncate_lines (current_buffer, Qnil);
563
564 /* If appropriate, copy enable-multibyte-characters into the minibuffer. */
565 if (inherit_input_method)
566 bset_enable_multibyte_characters (current_buffer, enable_multibyte);
567
568 /* The current buffer's default directory is usually the right thing
569 for our minibuffer here. However, if you're typing a command at
570 a minibuffer-only frame when minibuf_level is zero, then buf IS
571 the current_buffer, so reset_buffer leaves buf's default
572 directory unchanged. This is a bummer when you've just started
573 up Emacs and buf's default directory is Qnil. Here's a hack; can
574 you think of something better to do? Find another buffer with a
575 better directory, and use that one instead. */
576 if (STRINGP (ambient_dir))
577 bset_directory (current_buffer, ambient_dir);
578 else
579 {
580 Lisp_Object tail, buf;
581
582 FOR_EACH_LIVE_BUFFER (tail, buf)
583 if (STRINGP (BVAR (XBUFFER (buf), directory)))
584 {
585 bset_directory (current_buffer,
586 BVAR (XBUFFER (buf), directory));
587 break;
588 }
589 }
590
591 if (!EQ (mini_frame, selected_frame))
592 Fredirect_frame_focus (selected_frame, mini_frame);
593
594 Vminibuf_scroll_window = selected_window;
595 if (minibuf_level == 1 || !EQ (minibuf_window, selected_window))
596 minibuf_selected_window = selected_window;
597
598 /* Empty out the minibuffers of all frames other than the one
599 where we are going to display one now.
600 Set them to point to ` *Minibuf-0*', which is always empty. */
601 empty_minibuf = get_minibuffer (0);
602
603 FOR_EACH_FRAME (dummy, frame)
604 {
605 Lisp_Object root_window = Fframe_root_window (frame);
606 Lisp_Object mini_window = XWINDOW (root_window)->next;
607
608 if (! NILP (mini_window) && ! EQ (mini_window, minibuf_window)
609 && !NILP (Fwindow_minibuffer_p (mini_window)))
610 /* Use set_window_buffer instead of Fset_window_buffer (see
611 discussion of bug#11984, bug#12025, bug#12026). */
612 set_window_buffer (mini_window, empty_minibuf, 0, 0);
613 }
614
615 /* Display this minibuffer in the proper window. */
616 /* Use set_window_buffer instead of Fset_window_buffer (see
617 discussion of bug#11984, bug#12025, bug#12026). */
618 set_window_buffer (minibuf_window, Fcurrent_buffer (), 0, 0);
619 Fselect_window (minibuf_window, Qnil);
620 XWINDOW (minibuf_window)->hscroll = 0;
621
622 Fmake_local_variable (Qprint_escape_newlines);
623 print_escape_newlines = 1;
624
625 /* Erase the buffer. */
626 {
627 ptrdiff_t count1 = SPECPDL_INDEX ();
628 specbind (Qinhibit_read_only, Qt);
629 specbind (Qinhibit_modification_hooks, Qt);
630 Ferase_buffer ();
631
632 if (!NILP (BVAR (current_buffer, enable_multibyte_characters))
633 && ! STRING_MULTIBYTE (minibuf_prompt))
634 minibuf_prompt = Fstring_make_multibyte (minibuf_prompt);
635
636 /* Insert the prompt, record where it ends. */
637 Finsert (1, &minibuf_prompt);
638 if (PT > BEG)
639 {
640 Fput_text_property (make_number (BEG), make_number (PT),
641 Qfront_sticky, Qt, Qnil);
642 Fput_text_property (make_number (BEG), make_number (PT),
643 Qrear_nonsticky, Qt, Qnil);
644 Fput_text_property (make_number (BEG), make_number (PT),
645 Qfield, Qt, Qnil);
646 Fadd_text_properties (make_number (BEG), make_number (PT),
647 Vminibuffer_prompt_properties, Qnil);
648 }
649 unbind_to (count1, Qnil);
650 }
651
652 minibuf_prompt_width = current_column ();
653
654 /* Put in the initial input. */
655 if (!NILP (initial))
656 {
657 Finsert (1, &initial);
658 Fforward_char (make_number (pos));
659 }
660
661 clear_message (1, 1);
662 bset_keymap (current_buffer, map);
663
664 /* Turn on an input method stored in INPUT_METHOD if any. */
665 if (STRINGP (input_method) && !NILP (Ffboundp (Qactivate_input_method)))
666 call1 (Qactivate_input_method, input_method);
667
668 Frun_hooks (1, &Qminibuffer_setup_hook);
669
670 /* Don't allow the user to undo past this point. */
671 bset_undo_list (current_buffer, Qnil);
672
673 recursive_edit_1 ();
674
675 /* If cursor is on the minibuffer line,
676 show the user we have exited by putting it in column 0. */
677 if (XWINDOW (minibuf_window)->cursor.vpos >= 0
678 && !noninteractive)
679 {
680 XWINDOW (minibuf_window)->cursor.hpos = 0;
681 XWINDOW (minibuf_window)->cursor.x = 0;
682 XWINDOW (minibuf_window)->must_be_updated_p = 1;
683 update_frame (XFRAME (selected_frame), 1, 1);
684 flush_frame (XFRAME (XWINDOW (minibuf_window)->frame));
685 }
686
687 /* Make minibuffer contents into a string. */
688 Fset_buffer (minibuffer);
689 if (allow_props)
690 val = Fminibuffer_contents ();
691 else
692 val = Fminibuffer_contents_no_properties ();
693
694 /* VAL is the string of minibuffer text. */
695
696 last_minibuf_string = val;
697
698 /* Choose the string to add to the history. */
699 if (SCHARS (val) != 0)
700 histstring = val;
701 else if (STRINGP (defalt))
702 histstring = defalt;
703 else if (CONSP (defalt) && STRINGP (XCAR (defalt)))
704 histstring = XCAR (defalt);
705 else
706 histstring = Qnil;
707
708 /* Add the value to the appropriate history list, if any. */
709 if (!NILP (Vhistory_add_new_input)
710 && SYMBOLP (Vminibuffer_history_variable)
711 && !NILP (histstring))
712 {
713 /* If the caller wanted to save the value read on a history list,
714 then do so if the value is not already the front of the list. */
715
716 /* The value of the history variable must be a cons or nil. Other
717 values are unacceptable. We silently ignore these values. */
718
719 if (NILP (histval)
720 || (CONSP (histval)
721 /* Don't duplicate the most recent entry in the history. */
722 && (NILP (Fequal (histstring, Fcar (histval))))))
723 {
724 Lisp_Object length;
725
726 if (history_delete_duplicates) Fdelete (histstring, histval);
727 histval = Fcons (histstring, histval);
728 Fset (Vminibuffer_history_variable, histval);
729
730 /* Truncate if requested. */
731 length = Fget (Vminibuffer_history_variable, Qhistory_length);
732 if (NILP (length)) length = Vhistory_length;
733 if (INTEGERP (length))
734 {
735 if (XINT (length) <= 0)
736 Fset (Vminibuffer_history_variable, Qnil);
737 else
738 {
739 Lisp_Object temp;
740
741 temp = Fnthcdr (Fsub1 (length), histval);
742 if (CONSP (temp)) Fsetcdr (temp, Qnil);
743 }
744 }
745 }
746 }
747
748 /* If Lisp form desired instead of string, parse it. */
749 if (expflag)
750 val = string_to_object (val, defalt);
751
752 /* The appropriate frame will get selected
753 in set-window-configuration. */
754 UNGCPRO;
755 return unbind_to (count, val);
756 }
757
758 /* Return a buffer to be used as the minibuffer at depth `depth'.
759 depth = 0 is the lowest allowed argument, and that is the value
760 used for nonrecursive minibuffer invocations. */
761
762 Lisp_Object
763 get_minibuffer (EMACS_INT depth)
764 {
765 Lisp_Object tail, num, buf;
766 char name[sizeof " *Minibuf-*" + INT_STRLEN_BOUND (EMACS_INT)];
767
768 XSETFASTINT (num, depth);
769 tail = Fnthcdr (num, Vminibuffer_list);
770 if (NILP (tail))
771 {
772 tail = list1 (Qnil);
773 Vminibuffer_list = nconc2 (Vminibuffer_list, tail);
774 }
775 buf = Fcar (tail);
776 if (NILP (buf) || !BUFFER_LIVE_P (XBUFFER (buf)))
777 {
778 buf = Fget_buffer_create
779 (make_formatted_string (name, " *Minibuf-%"pI"d*", depth));
780
781 /* Although the buffer's name starts with a space, undo should be
782 enabled in it. */
783 Fbuffer_enable_undo (buf);
784
785 XSETCAR (tail, buf);
786 }
787 else
788 {
789 ptrdiff_t count = SPECPDL_INDEX ();
790 /* We have to empty both overlay lists. Otherwise we end
791 up with overlays that think they belong to this buffer
792 while the buffer doesn't know about them any more. */
793 delete_all_overlays (XBUFFER (buf));
794 reset_buffer (XBUFFER (buf));
795 record_unwind_current_buffer ();
796 Fset_buffer (buf);
797 if (!NILP (Ffboundp (intern ("minibuffer-inactive-mode"))))
798 call0 (intern ("minibuffer-inactive-mode"));
799 else
800 Fkill_all_local_variables ();
801 unbind_to (count, Qnil);
802 }
803
804 return buf;
805 }
806
807 static void
808 run_exit_minibuf_hook (void)
809 {
810 safe_run_hooks (Qminibuffer_exit_hook);
811 }
812
813 /* This function is called on exiting minibuffer, whether normally or
814 not, and it restores the current window, buffer, etc. */
815
816 static void
817 read_minibuf_unwind (void)
818 {
819 Lisp_Object old_deactivate_mark;
820 Lisp_Object window;
821
822 /* If this was a recursive minibuffer,
823 tie the minibuffer window back to the outer level minibuffer buffer. */
824 minibuf_level--;
825
826 window = minibuf_window;
827 /* To keep things predictable, in case it matters, let's be in the
828 minibuffer when we reset the relevant variables. */
829 Fset_buffer (XWINDOW (window)->contents);
830
831 /* Restore prompt, etc, from outer minibuffer level. */
832 minibuf_prompt = Fcar (minibuf_save_list);
833 minibuf_save_list = Fcdr (minibuf_save_list);
834 minibuf_prompt_width = XFASTINT (Fcar (minibuf_save_list));
835 minibuf_save_list = Fcdr (minibuf_save_list);
836 Vhelp_form = Fcar (minibuf_save_list);
837 minibuf_save_list = Fcdr (minibuf_save_list);
838 Vcurrent_prefix_arg = Fcar (minibuf_save_list);
839 minibuf_save_list = Fcdr (minibuf_save_list);
840 Vminibuffer_history_position = Fcar (minibuf_save_list);
841 minibuf_save_list = Fcdr (minibuf_save_list);
842 Vminibuffer_history_variable = Fcar (minibuf_save_list);
843 minibuf_save_list = Fcdr (minibuf_save_list);
844 Voverriding_local_map = Fcar (minibuf_save_list);
845 minibuf_save_list = Fcdr (minibuf_save_list);
846 #if 0
847 temp = Fcar (minibuf_save_list);
848 if (FRAME_LIVE_P (XFRAME (WINDOW_FRAME (XWINDOW (temp)))))
849 minibuf_window = temp;
850 #endif
851 minibuf_save_list = Fcdr (minibuf_save_list);
852
853 /* Erase the minibuffer we were using at this level. */
854 {
855 ptrdiff_t count = SPECPDL_INDEX ();
856 /* Prevent error in erase-buffer. */
857 specbind (Qinhibit_read_only, Qt);
858 specbind (Qinhibit_modification_hooks, Qt);
859 old_deactivate_mark = Vdeactivate_mark;
860 Ferase_buffer ();
861 Vdeactivate_mark = old_deactivate_mark;
862 unbind_to (count, Qnil);
863 }
864
865 /* When we get to the outmost level, make sure we resize the
866 mini-window back to its normal size. */
867 if (minibuf_level == 0)
868 resize_mini_window (XWINDOW (window), 0);
869
870 /* In case the previous minibuffer displayed in this miniwindow is
871 dead, we may keep displaying this buffer (tho it's inactive), so reset it,
872 to make sure we don't leave around bindings and stuff which only
873 made sense during the read_minibuf invocation. */
874 call0 (intern ("minibuffer-inactive-mode"));
875 }
876 \f
877
878 DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
879 Sread_from_minibuffer, 1, 7, 0,
880 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
881 The optional second arg INITIAL-CONTENTS is an obsolete alternative to
882 DEFAULT-VALUE. It normally should be nil in new code, except when
883 HIST is a cons. It is discussed in more detail below.
884
885 Third arg KEYMAP is a keymap to use whilst reading;
886 if omitted or nil, the default is `minibuffer-local-map'.
887
888 If fourth arg READ is non-nil, interpret the result as a Lisp object
889 and return that object:
890 in other words, do `(car (read-from-string INPUT-STRING))'
891
892 Fifth arg HIST, if non-nil, specifies a history list and optionally
893 the initial position in the list. It can be a symbol, which is the
894 history list variable to use, or a cons cell (HISTVAR . HISTPOS).
895 In that case, HISTVAR is the history list variable to use, and
896 HISTPOS is the initial position for use by the minibuffer history
897 commands. For consistency, you should also specify that element of
898 the history as the value of INITIAL-CONTENTS. Positions are counted
899 starting from 1 at the beginning of the list.
900
901 Sixth arg DEFAULT-VALUE, if non-nil, should be a string, which is used
902 as the default to `read' if READ is non-nil and the user enters
903 empty input. But if READ is nil, this function does _not_ return
904 DEFAULT-VALUE for empty input! Instead, it returns the empty string.
905
906 Whatever the value of READ, DEFAULT-VALUE is made available via the
907 minibuffer history commands. DEFAULT-VALUE can also be a list of
908 strings, in which case all the strings are available in the history,
909 and the first string is the default to `read' if READ is non-nil.
910
911 Seventh arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
912 the current input method and the setting of `enable-multibyte-characters'.
913
914 If the variable `minibuffer-allow-text-properties' is non-nil,
915 then the string which is returned includes whatever text properties
916 were present in the minibuffer. Otherwise the value has no text properties.
917
918 The remainder of this documentation string describes the
919 INITIAL-CONTENTS argument in more detail. It is only relevant when
920 studying existing code, or when HIST is a cons. If non-nil,
921 INITIAL-CONTENTS is a string to be inserted into the minibuffer before
922 reading input. Normally, point is put at the end of that string.
923 However, if INITIAL-CONTENTS is \(STRING . POSITION), the initial
924 input is STRING, but point is placed at _one-indexed_ position
925 POSITION in the minibuffer. Any integer value less than or equal to
926 one puts point at the beginning of the string. *Note* that this
927 behavior differs from the way such arguments are used in `completing-read'
928 and some related functions, which use zero-indexing for POSITION. */)
929 (Lisp_Object prompt, Lisp_Object initial_contents, Lisp_Object keymap, Lisp_Object read, Lisp_Object hist, Lisp_Object default_value, Lisp_Object inherit_input_method)
930 {
931 Lisp_Object histvar, histpos, val;
932 struct gcpro gcpro1;
933
934 CHECK_STRING (prompt);
935 if (NILP (keymap))
936 keymap = Vminibuffer_local_map;
937 else
938 keymap = get_keymap (keymap, 1, 0);
939
940 if (SYMBOLP (hist))
941 {
942 histvar = hist;
943 histpos = Qnil;
944 }
945 else
946 {
947 histvar = Fcar_safe (hist);
948 histpos = Fcdr_safe (hist);
949 }
950 if (NILP (histvar))
951 histvar = Qminibuffer_history;
952 if (NILP (histpos))
953 XSETFASTINT (histpos, 0);
954
955 GCPRO1 (default_value);
956 val = read_minibuf (keymap, initial_contents, prompt,
957 !NILP (read),
958 histvar, histpos, default_value,
959 minibuffer_allow_text_properties,
960 !NILP (inherit_input_method));
961 UNGCPRO;
962 return val;
963 }
964
965 /* Functions that use the minibuffer to read various things. */
966
967 DEFUN ("read-string", Fread_string, Sread_string, 1, 5, 0,
968 doc: /* Read a string from the minibuffer, prompting with string PROMPT.
969 If non-nil, second arg INITIAL-INPUT is a string to insert before reading.
970 This argument has been superseded by DEFAULT-VALUE and should normally be nil
971 in new code. It behaves as INITIAL-CONTENTS in `read-from-minibuffer' (which
972 see).
973 The third arg HISTORY, if non-nil, specifies a history list
974 and optionally the initial position in the list.
975 See `read-from-minibuffer' for details of HISTORY argument.
976 Fourth arg DEFAULT-VALUE is the default value or the list of default values.
977 If non-nil, it is used for history commands, and as the value (or the first
978 element of the list of default values) to return if the user enters the
979 empty string.
980 Fifth arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
981 the current input method and the setting of `enable-multibyte-characters'. */)
982 (Lisp_Object prompt, Lisp_Object initial_input, Lisp_Object history, Lisp_Object default_value, Lisp_Object inherit_input_method)
983 {
984 Lisp_Object val;
985 ptrdiff_t count = SPECPDL_INDEX ();
986
987 /* Just in case we're in a recursive minibuffer, make it clear that the
988 previous minibuffer's completion table does not apply to the new
989 minibuffer.
990 FIXME: `minibuffer-completion-table' should be buffer-local instead. */
991 specbind (Qminibuffer_completion_table, Qnil);
992
993 val = Fread_from_minibuffer (prompt, initial_input, Qnil,
994 Qnil, history, default_value,
995 inherit_input_method);
996 if (STRINGP (val) && SCHARS (val) == 0 && ! NILP (default_value))
997 val = CONSP (default_value) ? XCAR (default_value) : default_value;
998 return unbind_to (count, val);
999 }
1000
1001 DEFUN ("read-no-blanks-input", Fread_no_blanks_input, Sread_no_blanks_input, 1, 3, 0,
1002 doc: /* Read a string from the terminal, not allowing blanks.
1003 Prompt with PROMPT. Whitespace terminates the input. If INITIAL is
1004 non-nil, it should be a string, which is used as initial input, with
1005 point positioned at the end, so that SPACE will accept the input.
1006 \(Actually, INITIAL can also be a cons of a string and an integer.
1007 Such values are treated as in `read-from-minibuffer', but are normally
1008 not useful in this function.)
1009 Third arg INHERIT-INPUT-METHOD, if non-nil, means the minibuffer inherits
1010 the current input method and the setting of`enable-multibyte-characters'. */)
1011 (Lisp_Object prompt, Lisp_Object initial, Lisp_Object inherit_input_method)
1012 {
1013 CHECK_STRING (prompt);
1014 return read_minibuf (Vminibuffer_local_ns_map, initial, prompt,
1015 0, Qminibuffer_history, make_number (0), Qnil, 0,
1016 !NILP (inherit_input_method));
1017 }
1018
1019 DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
1020 doc: /* Read the name of a command and return as a symbol.
1021 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1022 if it is a list. */)
1023 (Lisp_Object prompt, Lisp_Object default_value)
1024 {
1025 Lisp_Object name, default_string;
1026
1027 if (NILP (default_value))
1028 default_string = Qnil;
1029 else if (SYMBOLP (default_value))
1030 default_string = SYMBOL_NAME (default_value);
1031 else
1032 default_string = default_value;
1033
1034 name = Fcompleting_read (prompt, Vobarray, Qcommandp, Qt,
1035 Qnil, Qnil, default_string, Qnil);
1036 if (NILP (name))
1037 return name;
1038 return Fintern (name, Qnil);
1039 }
1040
1041 #ifdef NOTDEF
1042 DEFUN ("read-function", Fread_function, Sread_function, 1, 1, 0,
1043 doc: /* One arg PROMPT, a string. Read the name of a function and return as a symbol.
1044 Prompt with PROMPT. */)
1045 (Lisp_Object prompt)
1046 {
1047 return Fintern (Fcompleting_read (prompt, Vobarray, Qfboundp, Qt, Qnil, Qnil, Qnil, Qnil),
1048 Qnil);
1049 }
1050 #endif /* NOTDEF */
1051
1052 DEFUN ("read-variable", Fread_variable, Sread_variable, 1, 2, 0,
1053 doc: /* Read the name of a user option and return it as a symbol.
1054 Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
1055 if it is a list.
1056 A user option, or customizable variable, is one for which
1057 `custom-variable-p' returns non-nil. */)
1058 (Lisp_Object prompt, Lisp_Object default_value)
1059 {
1060 Lisp_Object name, default_string;
1061
1062 if (NILP (default_value))
1063 default_string = Qnil;
1064 else if (SYMBOLP (default_value))
1065 default_string = SYMBOL_NAME (default_value);
1066 else
1067 default_string = default_value;
1068
1069 name = Fcompleting_read (prompt, Vobarray,
1070 Qcustom_variable_p, Qt,
1071 Qnil, Qnil, default_string, Qnil);
1072 if (NILP (name))
1073 return name;
1074 return Fintern (name, Qnil);
1075 }
1076
1077 DEFUN ("read-buffer", Fread_buffer, Sread_buffer, 1, 3, 0,
1078 doc: /* Read the name of a buffer and return as a string.
1079 Prompt with PROMPT.
1080 Optional second arg DEF is value to return if user enters an empty line.
1081 If DEF is a list of default values, return its first element.
1082 Optional third arg REQUIRE-MATCH determines whether non-existing
1083 buffer names are allowed. It has the same meaning as the
1084 REQUIRE-MATCH argument of `completing-read'.
1085 The argument PROMPT should be a string ending with a colon and a space.
1086 If `read-buffer-completion-ignore-case' is non-nil, completion ignores
1087 case while reading the buffer name.
1088 If `read-buffer-function' is non-nil, this works by calling it as a
1089 function, instead of the usual behavior. */)
1090 (Lisp_Object prompt, Lisp_Object def, Lisp_Object require_match)
1091 {
1092 Lisp_Object args[4], result;
1093 char *s;
1094 ptrdiff_t len;
1095 ptrdiff_t count = SPECPDL_INDEX ();
1096
1097 if (BUFFERP (def))
1098 def = BVAR (XBUFFER (def), name);
1099
1100 specbind (Qcompletion_ignore_case,
1101 read_buffer_completion_ignore_case ? Qt : Qnil);
1102
1103 if (NILP (Vread_buffer_function))
1104 {
1105 if (!NILP (def))
1106 {
1107 /* A default value was provided: we must change PROMPT,
1108 editing the default value in before the colon. To achieve
1109 this, we replace PROMPT with a substring that doesn't
1110 contain the terminal space and colon (if present). They
1111 are then added back using Fformat. */
1112
1113 if (STRINGP (prompt))
1114 {
1115 s = SSDATA (prompt);
1116 len = SBYTES (prompt);
1117 if (len >= 2 && s[len - 2] == ':' && s[len - 1] == ' ')
1118 len = len - 2;
1119 else if (len >= 1 && (s[len - 1] == ':' || s[len - 1] == ' '))
1120 len--;
1121
1122 prompt = make_specified_string (s, -1, len,
1123 STRING_MULTIBYTE (prompt));
1124 }
1125
1126 args[0] = build_string ("%s (default %s): ");
1127 args[1] = prompt;
1128 args[2] = CONSP (def) ? XCAR (def) : def;
1129 prompt = Fformat (3, args);
1130 }
1131
1132 result = Fcompleting_read (prompt, intern ("internal-complete-buffer"),
1133 Qnil, require_match, Qnil,
1134 Qbuffer_name_history, def, Qnil);
1135 }
1136 else
1137 {
1138 args[0] = Vread_buffer_function;
1139 args[1] = prompt;
1140 args[2] = def;
1141 args[3] = require_match;
1142 result = Ffuncall (4, args);
1143 }
1144 return unbind_to (count, result);
1145 }
1146 \f
1147 static Lisp_Object
1148 minibuf_conform_representation (Lisp_Object string, Lisp_Object basis)
1149 {
1150 if (STRING_MULTIBYTE (string) == STRING_MULTIBYTE (basis))
1151 return string;
1152
1153 if (STRING_MULTIBYTE (string))
1154 return Fstring_make_unibyte (string);
1155 else
1156 return Fstring_make_multibyte (string);
1157 }
1158
1159 DEFUN ("try-completion", Ftry_completion, Stry_completion, 2, 3, 0,
1160 doc: /* Return common substring of all completions of STRING in COLLECTION.
1161 Test each possible completion specified by COLLECTION
1162 to see if it begins with STRING. The possible completions may be
1163 strings or symbols. Symbols are converted to strings before testing,
1164 see `symbol-name'.
1165 All that match STRING are compared together; the longest initial sequence
1166 common to all these matches is the return value.
1167 If there is no match at all, the return value is nil.
1168 For a unique match which is exact, the return value is t.
1169
1170 If COLLECTION is an alist, the keys (cars of elements) are the
1171 possible completions. If an element is not a cons cell, then the
1172 element itself is the possible completion.
1173 If COLLECTION is a hash-table, all the keys that are strings or symbols
1174 are the possible completions.
1175 If COLLECTION is an obarray, the names of all symbols in the obarray
1176 are the possible completions.
1177
1178 COLLECTION can also be a function to do the completion itself.
1179 It receives three arguments: the values STRING, PREDICATE and nil.
1180 Whatever it returns becomes the value of `try-completion'.
1181
1182 If optional third argument PREDICATE is non-nil,
1183 it is used to test each possible match.
1184 The match is a candidate only if PREDICATE returns non-nil.
1185 The argument given to PREDICATE is the alist element
1186 or the symbol from the obarray. If COLLECTION is a hash-table,
1187 predicate is called with two arguments: the key and the value.
1188 Additionally to this predicate, `completion-regexp-list'
1189 is used to further constrain the set of candidates. */)
1190 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1191 {
1192 Lisp_Object bestmatch, tail, elt, eltstring;
1193 /* Size in bytes of BESTMATCH. */
1194 ptrdiff_t bestmatchsize = 0;
1195 /* These are in bytes, too. */
1196 ptrdiff_t compare, matchsize;
1197 enum { function_table, list_table, obarray_table, hash_table}
1198 type = (HASH_TABLE_P (collection) ? hash_table
1199 : VECTORP (collection) ? obarray_table
1200 : ((NILP (collection)
1201 || (CONSP (collection) && !FUNCTIONP (collection)))
1202 ? list_table : function_table));
1203 ptrdiff_t idx = 0, obsize = 0;
1204 int matchcount = 0;
1205 ptrdiff_t bindcount = -1;
1206 Lisp_Object bucket, zero, end, tem;
1207 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1208
1209 CHECK_STRING (string);
1210 if (type == function_table)
1211 return call3 (collection, string, predicate, Qnil);
1212
1213 bestmatch = bucket = Qnil;
1214 zero = make_number (0);
1215
1216 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1217 tail = collection;
1218 if (type == obarray_table)
1219 {
1220 collection = check_obarray (collection);
1221 obsize = ASIZE (collection);
1222 bucket = AREF (collection, idx);
1223 }
1224
1225 while (1)
1226 {
1227 /* Get the next element of the alist, obarray, or hash-table. */
1228 /* Exit the loop if the elements are all used up. */
1229 /* elt gets the alist element or symbol.
1230 eltstring gets the name to check as a completion. */
1231
1232 if (type == list_table)
1233 {
1234 if (!CONSP (tail))
1235 break;
1236 elt = XCAR (tail);
1237 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1238 tail = XCDR (tail);
1239 }
1240 else if (type == obarray_table)
1241 {
1242 if (!EQ (bucket, zero))
1243 {
1244 if (!SYMBOLP (bucket))
1245 error ("Bad data in guts of obarray");
1246 elt = bucket;
1247 eltstring = elt;
1248 if (XSYMBOL (bucket)->next)
1249 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1250 else
1251 XSETFASTINT (bucket, 0);
1252 }
1253 else if (++idx >= obsize)
1254 break;
1255 else
1256 {
1257 bucket = AREF (collection, idx);
1258 continue;
1259 }
1260 }
1261 else /* if (type == hash_table) */
1262 {
1263 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1264 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1265 idx++;
1266 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1267 break;
1268 else
1269 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1270 }
1271
1272 /* Is this element a possible completion? */
1273
1274 if (SYMBOLP (eltstring))
1275 eltstring = Fsymbol_name (eltstring);
1276
1277 if (STRINGP (eltstring)
1278 && SCHARS (string) <= SCHARS (eltstring)
1279 && (tem = Fcompare_strings (eltstring, zero,
1280 make_number (SCHARS (string)),
1281 string, zero, Qnil,
1282 completion_ignore_case ? Qt : Qnil),
1283 EQ (Qt, tem)))
1284 {
1285 /* Yes. */
1286 Lisp_Object regexps;
1287
1288 /* Ignore this element if it fails to match all the regexps. */
1289 {
1290 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1291 regexps = XCDR (regexps))
1292 {
1293 if (bindcount < 0) {
1294 bindcount = SPECPDL_INDEX ();
1295 specbind (Qcase_fold_search,
1296 completion_ignore_case ? Qt : Qnil);
1297 }
1298 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1299 if (NILP (tem))
1300 break;
1301 }
1302 if (CONSP (regexps))
1303 continue;
1304 }
1305
1306 /* Ignore this element if there is a predicate
1307 and the predicate doesn't like it. */
1308
1309 if (!NILP (predicate))
1310 {
1311 if (EQ (predicate, Qcommandp))
1312 tem = Fcommandp (elt, Qnil);
1313 else
1314 {
1315 if (bindcount >= 0)
1316 {
1317 unbind_to (bindcount, Qnil);
1318 bindcount = -1;
1319 }
1320 GCPRO4 (tail, string, eltstring, bestmatch);
1321 tem = (type == hash_table
1322 ? call2 (predicate, elt,
1323 HASH_VALUE (XHASH_TABLE (collection),
1324 idx - 1))
1325 : call1 (predicate, elt));
1326 UNGCPRO;
1327 }
1328 if (NILP (tem)) continue;
1329 }
1330
1331 /* Update computation of how much all possible completions match */
1332
1333 if (NILP (bestmatch))
1334 {
1335 matchcount = 1;
1336 bestmatch = eltstring;
1337 bestmatchsize = SCHARS (eltstring);
1338 }
1339 else
1340 {
1341 compare = min (bestmatchsize, SCHARS (eltstring));
1342 tem = Fcompare_strings (bestmatch, zero,
1343 make_number (compare),
1344 eltstring, zero,
1345 make_number (compare),
1346 completion_ignore_case ? Qt : Qnil);
1347 matchsize = EQ (tem, Qt) ? compare : eabs (XINT (tem)) - 1;
1348
1349 if (completion_ignore_case)
1350 {
1351 /* If this is an exact match except for case,
1352 use it as the best match rather than one that is not an
1353 exact match. This way, we get the case pattern
1354 of the actual match. */
1355 if ((matchsize == SCHARS (eltstring)
1356 && matchsize < SCHARS (bestmatch))
1357 ||
1358 /* If there is more than one exact match ignoring case,
1359 and one of them is exact including case,
1360 prefer that one. */
1361 /* If there is no exact match ignoring case,
1362 prefer a match that does not change the case
1363 of the input. */
1364 ((matchsize == SCHARS (eltstring))
1365 ==
1366 (matchsize == SCHARS (bestmatch))
1367 && (tem = Fcompare_strings (eltstring, zero,
1368 make_number (SCHARS (string)),
1369 string, zero,
1370 Qnil,
1371 Qnil),
1372 EQ (Qt, tem))
1373 && (tem = Fcompare_strings (bestmatch, zero,
1374 make_number (SCHARS (string)),
1375 string, zero,
1376 Qnil,
1377 Qnil),
1378 ! EQ (Qt, tem))))
1379 bestmatch = eltstring;
1380 }
1381 if (bestmatchsize != SCHARS (eltstring)
1382 || bestmatchsize != matchsize)
1383 /* Don't count the same string multiple times. */
1384 matchcount += matchcount <= 1;
1385 bestmatchsize = matchsize;
1386 if (matchsize <= SCHARS (string)
1387 /* If completion-ignore-case is non-nil, don't
1388 short-circuit because we want to find the best
1389 possible match *including* case differences. */
1390 && !completion_ignore_case
1391 && matchcount > 1)
1392 /* No need to look any further. */
1393 break;
1394 }
1395 }
1396 }
1397
1398 if (bindcount >= 0) {
1399 unbind_to (bindcount, Qnil);
1400 bindcount = -1;
1401 }
1402
1403 if (NILP (bestmatch))
1404 return Qnil; /* No completions found. */
1405 /* If we are ignoring case, and there is no exact match,
1406 and no additional text was supplied,
1407 don't change the case of what the user typed. */
1408 if (completion_ignore_case && bestmatchsize == SCHARS (string)
1409 && SCHARS (bestmatch) > bestmatchsize)
1410 return minibuf_conform_representation (string, bestmatch);
1411
1412 /* Return t if the supplied string is an exact match (counting case);
1413 it does not require any change to be made. */
1414 if (matchcount == 1 && !NILP (Fequal (bestmatch, string)))
1415 return Qt;
1416
1417 XSETFASTINT (zero, 0); /* Else extract the part in which */
1418 XSETFASTINT (end, bestmatchsize); /* all completions agree. */
1419 return Fsubstring (bestmatch, zero, end);
1420 }
1421 \f
1422 DEFUN ("all-completions", Fall_completions, Sall_completions, 2, 4, 0,
1423 doc: /* Search for partial matches to STRING in COLLECTION.
1424 Test each of the possible completions specified by COLLECTION
1425 to see if it begins with STRING. The possible completions may be
1426 strings or symbols. Symbols are converted to strings before testing,
1427 see `symbol-name'.
1428 The value is a list of all the possible completions that match STRING.
1429
1430 If COLLECTION is an alist, the keys (cars of elements) are the
1431 possible completions. If an element is not a cons cell, then the
1432 element itself is the possible completion.
1433 If COLLECTION is a hash-table, all the keys that are strings or symbols
1434 are the possible completions.
1435 If COLLECTION is an obarray, the names of all symbols in the obarray
1436 are the possible completions.
1437
1438 COLLECTION can also be a function to do the completion itself.
1439 It receives three arguments: the values STRING, PREDICATE and t.
1440 Whatever it returns becomes the value of `all-completions'.
1441
1442 If optional third argument PREDICATE is non-nil,
1443 it is used to test each possible match.
1444 The match is a candidate only if PREDICATE returns non-nil.
1445 The argument given to PREDICATE is the alist element
1446 or the symbol from the obarray. If COLLECTION is a hash-table,
1447 predicate is called with two arguments: the key and the value.
1448 Additionally to this predicate, `completion-regexp-list'
1449 is used to further constrain the set of candidates.
1450
1451 An obsolete optional fourth argument HIDE-SPACES is still accepted for
1452 backward compatibility. If non-nil, strings in COLLECTION that start
1453 with a space are ignored unless STRING itself starts with a space. */)
1454 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate, Lisp_Object hide_spaces)
1455 {
1456 Lisp_Object tail, elt, eltstring;
1457 Lisp_Object allmatches;
1458 int type = HASH_TABLE_P (collection) ? 3
1459 : VECTORP (collection) ? 2
1460 : NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection));
1461 ptrdiff_t idx = 0, obsize = 0;
1462 ptrdiff_t bindcount = -1;
1463 Lisp_Object bucket, tem, zero;
1464 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
1465
1466 CHECK_STRING (string);
1467 if (type == 0)
1468 return call3 (collection, string, predicate, Qt);
1469 allmatches = bucket = Qnil;
1470 zero = make_number (0);
1471
1472 /* If COLLECTION is not a list, set TAIL just for gc pro. */
1473 tail = collection;
1474 if (type == 2)
1475 {
1476 collection = check_obarray (collection);
1477 obsize = ASIZE (collection);
1478 bucket = AREF (collection, idx);
1479 }
1480
1481 while (1)
1482 {
1483 /* Get the next element of the alist, obarray, or hash-table. */
1484 /* Exit the loop if the elements are all used up. */
1485 /* elt gets the alist element or symbol.
1486 eltstring gets the name to check as a completion. */
1487
1488 if (type == 1)
1489 {
1490 if (!CONSP (tail))
1491 break;
1492 elt = XCAR (tail);
1493 eltstring = CONSP (elt) ? XCAR (elt) : elt;
1494 tail = XCDR (tail);
1495 }
1496 else if (type == 2)
1497 {
1498 if (!EQ (bucket, zero))
1499 {
1500 if (!SYMBOLP (bucket))
1501 error ("Bad data in guts of obarray");
1502 elt = bucket;
1503 eltstring = elt;
1504 if (XSYMBOL (bucket)->next)
1505 XSETSYMBOL (bucket, XSYMBOL (bucket)->next);
1506 else
1507 XSETFASTINT (bucket, 0);
1508 }
1509 else if (++idx >= obsize)
1510 break;
1511 else
1512 {
1513 bucket = AREF (collection, idx);
1514 continue;
1515 }
1516 }
1517 else /* if (type == 3) */
1518 {
1519 while (idx < HASH_TABLE_SIZE (XHASH_TABLE (collection))
1520 && NILP (HASH_HASH (XHASH_TABLE (collection), idx)))
1521 idx++;
1522 if (idx >= HASH_TABLE_SIZE (XHASH_TABLE (collection)))
1523 break;
1524 else
1525 elt = eltstring = HASH_KEY (XHASH_TABLE (collection), idx++);
1526 }
1527
1528 /* Is this element a possible completion? */
1529
1530 if (SYMBOLP (eltstring))
1531 eltstring = Fsymbol_name (eltstring);
1532
1533 if (STRINGP (eltstring)
1534 && SCHARS (string) <= SCHARS (eltstring)
1535 /* If HIDE_SPACES, reject alternatives that start with space
1536 unless the input starts with space. */
1537 && (NILP (hide_spaces)
1538 || (SBYTES (string) > 0
1539 && SREF (string, 0) == ' ')
1540 || SREF (eltstring, 0) != ' ')
1541 && (tem = Fcompare_strings (eltstring, zero,
1542 make_number (SCHARS (string)),
1543 string, zero,
1544 make_number (SCHARS (string)),
1545 completion_ignore_case ? Qt : Qnil),
1546 EQ (Qt, tem)))
1547 {
1548 /* Yes. */
1549 Lisp_Object regexps;
1550
1551 /* Ignore this element if it fails to match all the regexps. */
1552 {
1553 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1554 regexps = XCDR (regexps))
1555 {
1556 if (bindcount < 0) {
1557 bindcount = SPECPDL_INDEX ();
1558 specbind (Qcase_fold_search,
1559 completion_ignore_case ? Qt : Qnil);
1560 }
1561 tem = Fstring_match (XCAR (regexps), eltstring, zero);
1562 if (NILP (tem))
1563 break;
1564 }
1565 if (CONSP (regexps))
1566 continue;
1567 }
1568
1569 /* Ignore this element if there is a predicate
1570 and the predicate doesn't like it. */
1571
1572 if (!NILP (predicate))
1573 {
1574 if (EQ (predicate, Qcommandp))
1575 tem = Fcommandp (elt, Qnil);
1576 else
1577 {
1578 if (bindcount >= 0) {
1579 unbind_to (bindcount, Qnil);
1580 bindcount = -1;
1581 }
1582 GCPRO4 (tail, eltstring, allmatches, string);
1583 tem = type == 3
1584 ? call2 (predicate, elt,
1585 HASH_VALUE (XHASH_TABLE (collection), idx - 1))
1586 : call1 (predicate, elt);
1587 UNGCPRO;
1588 }
1589 if (NILP (tem)) continue;
1590 }
1591 /* Ok => put it on the list. */
1592 allmatches = Fcons (eltstring, allmatches);
1593 }
1594 }
1595
1596 if (bindcount >= 0) {
1597 unbind_to (bindcount, Qnil);
1598 bindcount = -1;
1599 }
1600
1601 return Fnreverse (allmatches);
1602 }
1603 \f
1604 DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
1605 doc: /* Read a string in the minibuffer, with completion.
1606 PROMPT is a string to prompt with; normally it ends in a colon and a space.
1607 COLLECTION can be a list of strings, an alist, an obarray or a hash table.
1608 COLLECTION can also be a function to do the completion itself.
1609 PREDICATE limits completion to a subset of COLLECTION.
1610 See `try-completion' and `all-completions' for more details
1611 on completion, COLLECTION, and PREDICATE.
1612
1613 REQUIRE-MATCH can take the following values:
1614 - t means that the user is not allowed to exit unless
1615 the input is (or completes to) an element of COLLECTION or is null.
1616 - nil means that the user can exit with any input.
1617 - `confirm' means that the user can exit with any input, but she needs
1618 to confirm her choice if the input is not an element of COLLECTION.
1619 - `confirm-after-completion' means that the user can exit with any
1620 input, but she needs to confirm her choice if she called
1621 `minibuffer-complete' right before `minibuffer-complete-and-exit'
1622 and the input is not an element of COLLECTION.
1623 - anything else behaves like t except that typing RET does not exit if it
1624 does non-null completion.
1625
1626 If the input is null, `completing-read' returns DEF, or the first element
1627 of the list of default values, or an empty string if DEF is nil,
1628 regardless of the value of REQUIRE-MATCH.
1629
1630 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
1631 with point positioned at the end.
1632 If it is (STRING . POSITION), the initial input is STRING, but point
1633 is placed at _zero-indexed_ position POSITION in STRING. (*Note*
1634 that this is different from `read-from-minibuffer' and related
1635 functions, which use one-indexing for POSITION.) This feature is
1636 deprecated--it is best to pass nil for INITIAL-INPUT and supply the
1637 default value DEF instead. The user can yank the default value into
1638 the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element].
1639
1640 HIST, if non-nil, specifies a history list and optionally the initial
1641 position in the list. It can be a symbol, which is the history list
1642 variable to use, or it can be a cons cell (HISTVAR . HISTPOS). In
1643 that case, HISTVAR is the history list variable to use, and HISTPOS
1644 is the initial position (the position in the list used by the
1645 minibuffer history commands). For consistency, you should also
1646 specify that element of the history as the value of
1647 INITIAL-INPUT. (This is the only case in which you should use
1648 INITIAL-INPUT instead of DEF.) Positions are counted starting from
1649 1 at the beginning of the list. The variable `history-length'
1650 controls the maximum length of a history list.
1651
1652 DEF, if non-nil, is the default value or the list of default values.
1653
1654 If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits
1655 the current input method and the setting of `enable-multibyte-characters'.
1656
1657 Completion ignores case if the ambient value of
1658 `completion-ignore-case' is non-nil.
1659
1660 See also `completing-read-function'. */)
1661 (Lisp_Object prompt, Lisp_Object collection, Lisp_Object predicate, Lisp_Object require_match, Lisp_Object initial_input, Lisp_Object hist, Lisp_Object def, Lisp_Object inherit_input_method)
1662 {
1663 Lisp_Object args[9];
1664 args[0] = Fsymbol_value (intern ("completing-read-function"));
1665 args[1] = prompt;
1666 args[2] = collection;
1667 args[3] = predicate;
1668 args[4] = require_match;
1669 args[5] = initial_input;
1670 args[6] = hist;
1671 args[7] = def;
1672 args[8] = inherit_input_method;
1673 return Ffuncall (9, args);
1674 }
1675 \f
1676 /* Test whether TXT is an exact completion. */
1677 DEFUN ("test-completion", Ftest_completion, Stest_completion, 2, 3, 0,
1678 doc: /* Return non-nil if STRING is a valid completion.
1679 Takes the same arguments as `all-completions' and `try-completion'.
1680 If COLLECTION is a function, it is called with three arguments:
1681 the values STRING, PREDICATE and `lambda'. */)
1682 (Lisp_Object string, Lisp_Object collection, Lisp_Object predicate)
1683 {
1684 Lisp_Object regexps, tail, tem = Qnil;
1685 ptrdiff_t i = 0;
1686
1687 CHECK_STRING (string);
1688
1689 if (NILP (collection) || (CONSP (collection) && !FUNCTIONP (collection)))
1690 {
1691 tem = Fassoc_string (string, collection, completion_ignore_case ? Qt : Qnil);
1692 if (NILP (tem))
1693 return Qnil;
1694 }
1695 else if (VECTORP (collection))
1696 {
1697 /* Bypass intern-soft as that loses for nil. */
1698 tem = oblookup (collection,
1699 SSDATA (string),
1700 SCHARS (string),
1701 SBYTES (string));
1702 if (!SYMBOLP (tem))
1703 {
1704 if (STRING_MULTIBYTE (string))
1705 string = Fstring_make_unibyte (string);
1706 else
1707 string = Fstring_make_multibyte (string);
1708
1709 tem = oblookup (collection,
1710 SSDATA (string),
1711 SCHARS (string),
1712 SBYTES (string));
1713 }
1714
1715 if (completion_ignore_case && !SYMBOLP (tem))
1716 {
1717 for (i = ASIZE (collection) - 1; i >= 0; i--)
1718 {
1719 tail = AREF (collection, i);
1720 if (SYMBOLP (tail))
1721 while (1)
1722 {
1723 if (EQ (Fcompare_strings (string, make_number (0), Qnil,
1724 Fsymbol_name (tail),
1725 make_number (0) , Qnil, Qt),
1726 Qt))
1727 {
1728 tem = tail;
1729 break;
1730 }
1731 if (XSYMBOL (tail)->next == 0)
1732 break;
1733 XSETSYMBOL (tail, XSYMBOL (tail)->next);
1734 }
1735 }
1736 }
1737
1738 if (!SYMBOLP (tem))
1739 return Qnil;
1740 }
1741 else if (HASH_TABLE_P (collection))
1742 {
1743 struct Lisp_Hash_Table *h = XHASH_TABLE (collection);
1744 Lisp_Object key = Qnil;
1745 i = hash_lookup (h, string, NULL);
1746 if (i >= 0)
1747 tem = HASH_KEY (h, i);
1748 else
1749 for (i = 0; i < HASH_TABLE_SIZE (h); ++i)
1750 if (!NILP (HASH_HASH (h, i))
1751 && (key = HASH_KEY (h, i),
1752 SYMBOLP (key) ? key = Fsymbol_name (key) : key,
1753 STRINGP (key))
1754 && EQ (Fcompare_strings (string, make_number (0), Qnil,
1755 key, make_number (0) , Qnil,
1756 completion_ignore_case ? Qt : Qnil),
1757 Qt))
1758 {
1759 tem = key;
1760 break;
1761 }
1762 if (!STRINGP (tem))
1763 return Qnil;
1764 }
1765 else
1766 return call3 (collection, string, predicate, Qlambda);
1767
1768 /* Reject this element if it fails to match all the regexps. */
1769 if (CONSP (Vcompletion_regexp_list))
1770 {
1771 ptrdiff_t count = SPECPDL_INDEX ();
1772 specbind (Qcase_fold_search, completion_ignore_case ? Qt : Qnil);
1773 for (regexps = Vcompletion_regexp_list; CONSP (regexps);
1774 regexps = XCDR (regexps))
1775 {
1776 if (NILP (Fstring_match (XCAR (regexps),
1777 SYMBOLP (tem) ? string : tem,
1778 Qnil)))
1779 return unbind_to (count, Qnil);
1780 }
1781 unbind_to (count, Qnil);
1782 }
1783
1784 /* Finally, check the predicate. */
1785 if (!NILP (predicate))
1786 {
1787 return HASH_TABLE_P (collection)
1788 ? call2 (predicate, tem, HASH_VALUE (XHASH_TABLE (collection), i))
1789 : call1 (predicate, tem);
1790 }
1791 else
1792 return Qt;
1793 }
1794
1795 static Lisp_Object Qmetadata;
1796
1797 DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete_buffer, 3, 3, 0,
1798 doc: /* Perform completion on buffer names.
1799 STRING and PREDICATE have the same meanings as in `try-completion',
1800 `all-completions', and `test-completion'.
1801
1802 If FLAG is nil, invoke `try-completion'; if it is t, invoke
1803 `all-completions'; otherwise invoke `test-completion'. */)
1804 (Lisp_Object string, Lisp_Object predicate, Lisp_Object flag)
1805 {
1806 if (NILP (flag))
1807 return Ftry_completion (string, Vbuffer_alist, predicate);
1808 else if (EQ (flag, Qt))
1809 {
1810 Lisp_Object res = Fall_completions (string, Vbuffer_alist, predicate, Qnil);
1811 if (SCHARS (string) > 0)
1812 return res;
1813 else
1814 { /* Strip out internal buffers. */
1815 Lisp_Object bufs = res;
1816 /* First, look for a non-internal buffer in `res'. */
1817 while (CONSP (bufs) && SREF (XCAR (bufs), 0) == ' ')
1818 bufs = XCDR (bufs);
1819 if (NILP (bufs))
1820 return (EQ (Flength (res), Flength (Vbuffer_alist))
1821 /* If all bufs are internal don't strip them out. */
1822 ? res : bufs);
1823 res = bufs;
1824 while (CONSP (XCDR (bufs)))
1825 if (SREF (XCAR (XCDR (bufs)), 0) == ' ')
1826 XSETCDR (bufs, XCDR (XCDR (bufs)));
1827 else
1828 bufs = XCDR (bufs);
1829 return res;
1830 }
1831 }
1832 else if (EQ (flag, Qlambda))
1833 return Ftest_completion (string, Vbuffer_alist, predicate);
1834 else if (EQ (flag, Qmetadata))
1835 return list2 (Qmetadata, Fcons (Qcategory, Qbuffer));
1836 else
1837 return Qnil;
1838 }
1839
1840 /* Like assoc but assumes KEY is a string, and ignores case if appropriate. */
1841
1842 DEFUN ("assoc-string", Fassoc_string, Sassoc_string, 2, 3, 0,
1843 doc: /* Like `assoc' but specifically for strings (and symbols).
1844
1845 This returns the first element of LIST whose car matches the string or
1846 symbol KEY, or nil if no match exists. When performing the
1847 comparison, symbols are first converted to strings, and unibyte
1848 strings to multibyte. If the optional arg CASE-FOLD is non-nil, case
1849 is ignored.
1850
1851 Unlike `assoc', KEY can also match an entry in LIST consisting of a
1852 single string, rather than a cons cell whose car is a string. */)
1853 (register Lisp_Object key, Lisp_Object list, Lisp_Object case_fold)
1854 {
1855 register Lisp_Object tail;
1856
1857 if (SYMBOLP (key))
1858 key = Fsymbol_name (key);
1859
1860 for (tail = list; CONSP (tail); tail = XCDR (tail))
1861 {
1862 register Lisp_Object elt, tem, thiscar;
1863 elt = XCAR (tail);
1864 thiscar = CONSP (elt) ? XCAR (elt) : elt;
1865 if (SYMBOLP (thiscar))
1866 thiscar = Fsymbol_name (thiscar);
1867 else if (!STRINGP (thiscar))
1868 continue;
1869 tem = Fcompare_strings (thiscar, make_number (0), Qnil,
1870 key, make_number (0), Qnil,
1871 case_fold);
1872 if (EQ (tem, Qt))
1873 return elt;
1874 QUIT;
1875 }
1876 return Qnil;
1877 }
1878
1879 \f
1880 DEFUN ("minibuffer-depth", Fminibuffer_depth, Sminibuffer_depth, 0, 0, 0,
1881 doc: /* Return current depth of activations of minibuffer, a nonnegative integer. */)
1882 (void)
1883 {
1884 return make_number (minibuf_level);
1885 }
1886
1887 DEFUN ("minibuffer-prompt", Fminibuffer_prompt, Sminibuffer_prompt, 0, 0, 0,
1888 doc: /* Return the prompt string of the currently-active minibuffer.
1889 If no minibuffer is active, return nil. */)
1890 (void)
1891 {
1892 return Fcopy_sequence (minibuf_prompt);
1893 }
1894
1895 \f
1896 void
1897 init_minibuf_once (void)
1898 {
1899 Vminibuffer_list = Qnil;
1900 staticpro (&Vminibuffer_list);
1901 }
1902
1903 void
1904 syms_of_minibuf (void)
1905 {
1906 minibuf_level = 0;
1907 minibuf_prompt = Qnil;
1908 staticpro (&minibuf_prompt);
1909
1910 minibuf_save_list = Qnil;
1911 staticpro (&minibuf_save_list);
1912
1913 DEFSYM (Qcompletion_ignore_case, "completion-ignore-case");
1914 DEFSYM (Qread_file_name_internal, "read-file-name-internal");
1915 DEFSYM (Qminibuffer_default, "minibuffer-default");
1916 Fset (Qminibuffer_default, Qnil);
1917
1918 DEFSYM (Qminibuffer_completion_table, "minibuffer-completion-table");
1919 DEFSYM (Qminibuffer_completion_confirm, "minibuffer-completion-confirm");
1920 DEFSYM (Qminibuffer_completion_predicate, "minibuffer-completion-predicate");
1921
1922 staticpro (&last_minibuf_string);
1923 last_minibuf_string = Qnil;
1924
1925 DEFSYM (Qminibuffer_history, "minibuffer-history");
1926 DEFSYM (Qbuffer_name_history, "buffer-name-history");
1927 Fset (Qbuffer_name_history, Qnil);
1928
1929 DEFSYM (Qcustom_variable_p, "custom-variable-p");
1930 DEFSYM (Qminibuffer_setup_hook, "minibuffer-setup-hook");
1931 DEFSYM (Qminibuffer_exit_hook, "minibuffer-exit-hook");
1932 DEFSYM (Qhistory_length, "history-length");
1933 DEFSYM (Qcurrent_input_method, "current-input-method");
1934 DEFSYM (Qactivate_input_method, "activate-input-method");
1935 DEFSYM (Qcase_fold_search, "case-fold-search");
1936 DEFSYM (Qmetadata, "metadata");
1937
1938 DEFVAR_LISP ("read-expression-history", Vread_expression_history,
1939 doc: /* A history list for arguments that are Lisp expressions to evaluate.
1940 For example, `eval-expression' uses this. */);
1941 Vread_expression_history = Qnil;
1942
1943 DEFSYM (Qread_expression_history, "read-expression-history");
1944
1945 DEFVAR_LISP ("read-buffer-function", Vread_buffer_function,
1946 doc: /* If this is non-nil, `read-buffer' does its work by calling this function.
1947 The function is called with the arguments passed to `read-buffer'. */);
1948 Vread_buffer_function = Qnil;
1949
1950 DEFVAR_BOOL ("read-buffer-completion-ignore-case",
1951 read_buffer_completion_ignore_case,
1952 doc: /* Non-nil means completion ignores case when reading a buffer name. */);
1953 read_buffer_completion_ignore_case = 0;
1954
1955 DEFVAR_LISP ("minibuffer-setup-hook", Vminibuffer_setup_hook,
1956 doc: /* Normal hook run just after entry to minibuffer. */);
1957 Vminibuffer_setup_hook = Qnil;
1958
1959 DEFVAR_LISP ("minibuffer-exit-hook", Vminibuffer_exit_hook,
1960 doc: /* Normal hook run just after exit from minibuffer. */);
1961 Vminibuffer_exit_hook = Qnil;
1962
1963 DEFVAR_LISP ("history-length", Vhistory_length,
1964 doc: /* Maximum length of history lists before truncation takes place.
1965 A number means truncate to that length; truncation deletes old
1966 elements, and is done just after inserting a new element.
1967 A value of t means no truncation.
1968
1969 This variable only affects history lists that don't specify their own
1970 maximum lengths. Setting the `history-length' property of a history
1971 variable overrides this default. */);
1972 XSETFASTINT (Vhistory_length, 100);
1973
1974 DEFVAR_BOOL ("history-delete-duplicates", history_delete_duplicates,
1975 doc: /* Non-nil means to delete duplicates in history.
1976 If set to t when adding a new history element, all previous identical
1977 elements are deleted from the history list. */);
1978 history_delete_duplicates = 0;
1979
1980 DEFVAR_LISP ("history-add-new-input", Vhistory_add_new_input,
1981 doc: /* Non-nil means to add new elements in history.
1982 If set to nil, minibuffer reading functions don't add new elements to the
1983 history list, so it is possible to do this afterwards by calling
1984 `add-to-history' explicitly. */);
1985 Vhistory_add_new_input = Qt;
1986
1987 DEFVAR_BOOL ("completion-ignore-case", completion_ignore_case,
1988 doc: /* Non-nil means don't consider case significant in completion.
1989 For file-name completion, `read-file-name-completion-ignore-case'
1990 controls the behavior, rather than this variable.
1991 For buffer name completion, `read-buffer-completion-ignore-case'
1992 controls the behavior, rather than this variable. */);
1993 completion_ignore_case = 0;
1994
1995 DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers,
1996 doc: /* Non-nil means to allow minibuffer commands while in the minibuffer.
1997 This variable makes a difference whenever the minibuffer window is active. */);
1998 enable_recursive_minibuffers = 0;
1999
2000 DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table,
2001 doc: /* Alist or obarray used for completion in the minibuffer.
2002 This becomes the ALIST argument to `try-completion' and `all-completions'.
2003 The value can also be a list of strings or a hash table.
2004
2005 The value may alternatively be a function, which is given three arguments:
2006 STRING, the current buffer contents;
2007 PREDICATE, the predicate for filtering possible matches;
2008 CODE, which says what kind of things to do.
2009 CODE can be nil, t or `lambda':
2010 nil -- return the best completion of STRING, or nil if there is none.
2011 t -- return a list of all possible completions of STRING.
2012 lambda -- return t if STRING is a valid completion as it stands. */);
2013 Vminibuffer_completion_table = Qnil;
2014
2015 DEFVAR_LISP ("minibuffer-completion-predicate", Vminibuffer_completion_predicate,
2016 doc: /* Within call to `completing-read', this holds the PREDICATE argument. */);
2017 Vminibuffer_completion_predicate = Qnil;
2018
2019 DEFVAR_LISP ("minibuffer-completion-confirm", Vminibuffer_completion_confirm,
2020 doc: /* Whether to demand confirmation of completion before exiting minibuffer.
2021 If nil, confirmation is not required.
2022 If the value is `confirm', the user may exit with an input that is not
2023 a valid completion alternative, but Emacs asks for confirmation.
2024 If the value is `confirm-after-completion', the user may exit with an
2025 input that is not a valid completion alternative, but Emacs asks for
2026 confirmation if the user submitted the input right after any of the
2027 completion commands listed in `minibuffer-confirm-exit-commands'. */);
2028 Vminibuffer_completion_confirm = Qnil;
2029
2030 DEFVAR_LISP ("minibuffer-completing-file-name",
2031 Vminibuffer_completing_file_name,
2032 doc: /* Non-nil means completing file names. */);
2033 Vminibuffer_completing_file_name = Qnil;
2034
2035 DEFVAR_LISP ("minibuffer-help-form", Vminibuffer_help_form,
2036 doc: /* Value that `help-form' takes on inside the minibuffer. */);
2037 Vminibuffer_help_form = Qnil;
2038
2039 DEFVAR_LISP ("minibuffer-history-variable", Vminibuffer_history_variable,
2040 doc: /* History list symbol to add minibuffer values to.
2041 Each string of minibuffer input, as it appears on exit from the minibuffer,
2042 is added with
2043 (set minibuffer-history-variable
2044 (cons STRING (symbol-value minibuffer-history-variable))) */);
2045 XSETFASTINT (Vminibuffer_history_variable, 0);
2046
2047 DEFVAR_LISP ("minibuffer-history-position", Vminibuffer_history_position,
2048 doc: /* Current position of redoing in the history list. */);
2049 Vminibuffer_history_position = Qnil;
2050
2051 DEFVAR_BOOL ("minibuffer-auto-raise", minibuffer_auto_raise,
2052 doc: /* Non-nil means entering the minibuffer raises the minibuffer's frame.
2053 Some uses of the echo area also raise that frame (since they use it too). */);
2054 minibuffer_auto_raise = 0;
2055
2056 DEFVAR_LISP ("completion-regexp-list", Vcompletion_regexp_list,
2057 doc: /* List of regexps that should restrict possible completions.
2058 The basic completion functions only consider a completion acceptable
2059 if it matches all regular expressions in this list, with
2060 `case-fold-search' bound to the value of `completion-ignore-case'.
2061 See Info node `(elisp)Basic Completion', for a description of these
2062 functions. */);
2063 Vcompletion_regexp_list = Qnil;
2064
2065 DEFVAR_BOOL ("minibuffer-allow-text-properties",
2066 minibuffer_allow_text_properties,
2067 doc: /* Non-nil means `read-from-minibuffer' should not discard text properties.
2068 This also affects `read-string', but it does not affect `read-minibuffer',
2069 `read-no-blanks-input', or any of the functions that do minibuffer input
2070 with completion; they always discard text properties. */);
2071 minibuffer_allow_text_properties = 0;
2072
2073 DEFVAR_LISP ("minibuffer-prompt-properties", Vminibuffer_prompt_properties,
2074 doc: /* Text properties that are added to minibuffer prompts.
2075 These are in addition to the basic `field' property, and stickiness
2076 properties. */);
2077 /* We use `intern' here instead of Qread_only to avoid
2078 initialization-order problems. */
2079 Vminibuffer_prompt_properties = list2 (intern_c_string ("read-only"), Qt);
2080
2081 defsubr (&Sactive_minibuffer_window);
2082 defsubr (&Sset_minibuffer_window);
2083 defsubr (&Sread_from_minibuffer);
2084 defsubr (&Sread_string);
2085 defsubr (&Sread_command);
2086 defsubr (&Sread_variable);
2087 defsubr (&Sinternal_complete_buffer);
2088 defsubr (&Sread_buffer);
2089 defsubr (&Sread_no_blanks_input);
2090 defsubr (&Sminibuffer_depth);
2091 defsubr (&Sminibuffer_prompt);
2092
2093 defsubr (&Sminibufferp);
2094 defsubr (&Sminibuffer_prompt_end);
2095 defsubr (&Sminibuffer_contents);
2096 defsubr (&Sminibuffer_contents_no_properties);
2097 defsubr (&Sminibuffer_completion_contents);
2098
2099 defsubr (&Stry_completion);
2100 defsubr (&Sall_completions);
2101 defsubr (&Stest_completion);
2102 defsubr (&Sassoc_string);
2103 defsubr (&Scompleting_read);
2104 }