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